docs: epic agent DX polish — docstrings, CLI tips, scaffold, RFC archive#241
Merged
docs: epic agent DX polish — docstrings, CLI tips, scaffold, RFC archive#241
Conversation
Close the five agent-DX discoverability gaps identified in the 2026-04-20 cold-read evaluation: - S1: Core-type docstrings. Site/Page/Section "When to use" intent coverage 1.2% → 71.6% (58/81), ~100% on the targeted non-trivial subset. - S2: AGENTS.md "Extending Bengal" section (91 lines) covering template functions, content types, CLI commands, build phases. Includes a 3-bullet Milo-vs-Click primer. - S3: `bengal new content-type <name>` scaffold generates a working ContentTypeStrategy subclass with register_strategy() call. - S4: Every `cli.error(...)` in bengal/cli/ now pairs with a guidance follow-up (cli.tip/info/render_write) within 3 lines. Coverage 27.1% → 100% (70/70). AST gate test enforces the rule for new additions. - S5: Archived 4 bucket-B RFCs with unambiguous done-signals to plan/complete/ and plan/evaluated/. Root plan/*.md count 69 → 65. Full rationale and per-sprint changelog in plan/epic-agent-dx-polish.md. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes the five agent-DX discoverability gaps identified in the 2026-04-20 cold-read evaluation, across five independently-shippable sprints tracked in
plan/epic-agent-dx-polish.md:Site/Page/Section"When to use" intent coverage 1.2% → 71.6% (58/81 members), ~100% on the targeted non-trivial subset. Plain domain facets (config getters,word_count,parent) intentionally left alone per CLAUDE.md.AGENTS.md"Extending Bengal" section: 91 lines covering 4 extension points (template functions, content types, CLI commands, build phases) with a 3-bullet Milo-vs-Click primer. End-to-end verified by a fresh-agent read.bengal new content-type <name>scaffold: Generates a workingContentTypeStrategysubclass withWhen to use:docstring,default_template,sort_pages(), andregister_strategy()call. 6 unit tests covering creation, import+register cycle, PascalCase, duplicates, invalid names.cli.error(...)inbengal/cli/now has acli.tip/cli.info/cli.render_writefollow-up within 3 lines (27.1% → 100%, 70/70). New AST gate testtests/unit/cli/test_cli_error_gates.pyenforces the rule for new additions.plan/complete//plan/evaluated/. Rootplan/*.mdcount 69 → 65. 3 cross-refs updated.plan/README.mdgained an Archive Structure section.Test plan
pytest tests/unit/cli/— 123 passed (includes new gate test + 6 scaffold tests)ruff check bengal/cli/ tests/unit/cli/— cleantytype checker — passes (pre-commit)get_strategy()returns itbengal hellocommand🤖 Generated with Claude Code