Skip to content

docs(config-new): correct 'Zero API calls' claim for scaffold mode - #667

Merged
padak merged 1 commit into
mainfrom
claude/vigorous-proskuriakova-ad5d98
Aug 23, 2026
Merged

docs(config-new): correct 'Zero API calls' claim for scaffold mode#667
padak merged 1 commit into
mainfrom
claude/vigorous-proskuriakova-ad5d98

Conversation

@padak

@padak padak commented Aug 23, 2026

Copy link
Copy Markdown
Member

Why

The docs for config new (default no---push scaffold mode) claimed "Zero API calls." That has never been true: commands/config.py::config_new calls ComponentService.generate_scaffold, which fetches the component detail from the AI Service (ai_client.get_component_detail) to derive the schema/examples — which is exactly why the --project option's own help says "for AI Service auth". Verified against the v0.33.0 sources: the AI Service read was there from the start, so even the "pre-v0.33.0" historical framing in gotchas.md was inaccurate.

An AI agent reading "zero API calls" would wrongly conclude the scaffold works offline / without a resolvable project token.

What

Corrected the claim to "no Storage write calls (one AI Service read for the component schema)" in the three surfaces that carried it:

  • plugins/kbagent/skills/kbagent/references/commands-reference.md — the config new entry
  • plugins/kbagent/skills/kbagent/references/gotchas.md — the "pre-v0.33.0 scaffold-only" historical entry
  • src/keboola_agent_cli/commands/config.py — the command's --help docstring

Checked and confirmed clean (claim not present): SKILL.md, keboola-expert.md, context.py AGENT_CONTEXT, CLAUDE.md command list, scaffold-workflow.md. The shipped 0.33.0 entry in changelog.py repeats the phrase but is left untouched as release history.

Docs-only change: no version bump, no changelog entry (per the #648 release process).

Testing

  • ruff check + ruff format --check clean on config.py
  • pytest tests/test_cli.py tests/test_config_create_cli.py tests/test_config_create_service.py — 278 passed

Open in Devin Review

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

The no-push scaffold mode of `config new` has never been offline:
ComponentService.generate_scaffold always fetches the component detail
from the AI Service (one read) to derive the schema/examples -- that is
exactly what --project authenticates. Only Storage WRITE calls are zero.

Corrected in the three surfaces carrying the claim: the command's --help
docstring, commands-reference.md, and the historical gotchas.md entry
(verified against v0.33.0 sources: the AI Service read was there from
the start). The shipped 0.33.0 changelog entry is left untouched as
release history. SKILL.md, keboola-expert.md, context.py AGENT_CONTEXT,
CLAUDE.md and scaffold-workflow.md never carried the claim.
@padak
padak force-pushed the claude/vigorous-proskuriakova-ad5d98 branch from 1ab2c05 to f68e2ce Compare August 23, 2026 20:29
@padak
padak merged commit 45f718b into main Aug 23, 2026
4 checks passed
@padak
padak deleted the claude/vigorous-proskuriakova-ad5d98 branch August 23, 2026 20:47
@padak padak mentioned this pull request Aug 23, 2026
10 tasks
padak added a commit that referenced this pull request Aug 23, 2026
* chore(release): 0.90.0

Bumps pyproject.toml to 0.90.0 and adds the changelog entry covering every
PR merged since v0.89.0 (#658, #662, #661, #663, #665, #666, #664, #668,
#667, #623), resolves the vNEXT placeholders those PRs left behind, and
adds the curated What's new reel for the release.

* docs(web-server): keep the What's-new anchor stable across releases

The '### What's-new popup *(since vNEXT)*' heading put the version gate in
the heading itself, so resolving the placeholder to 0.90.0 changed the
generated slug to 'whats-new-popup-since-0900' and broke the in-page link
at line 138 -- and would have broken it again on every future release.

Moved the '(since 0.90.0)' tag to the first body line: the anchor is now
the stable 'whats-new-popup', the gate stays visible, and
check_version_gates.py still sees it (it scans the whole file, not just
headings).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant