[developer-docs] Developer Documentation Consolidation - 2026-05-30 #35929
Closed
Replies: 1 comment
-
|
This discussion was automatically closed because it expired on 2026-06-02T14:10:30.344Z.
|
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Summary
Weekly maintenance pass over the
scratchpad/developer specifications. The corpus is mature (dev.mdis at v9.14 with dozens of prior consolidation runs), so most marketing language was already removed in earlier passes. This run scanned 64 spec files, fixed 2 residual subjective-tone issues, documented 1 recently-merged architectural change, and bumped the consolidatedscratchpad/dev.mdto v9.15.Tone Fixes
token-budget-guidelines.md:242comprehensive→removed pattern)engine-review-summary.md:1Deep→Detailedpattern)Documentation Added
In
dev.md→ Safe Outputs System → Common Configuration Patterns, clarified thattarget-repoandallowed-reposare honored by all safe-output handlers — includingadd-labels,remove-labels, andassign-to-user— not onlycreate-issue, and that handler configuration is generated into a singleconfig.jsonfrom the handler registry as the single source of truth. This keeps cross-repository routing and authentication (includinggithub-token) consistent across handlers. Sourced from PR #35901 (fix: safe output handlers now respect target-repo config) and the relatedsingle-source-safe-outputs-config/fix-safe-output-cross-repo-authchangesets. Addedallowed-reposto the Cross-Repository YAML example.Scan methodology and findings
Tone scan
Scanned all 64
scratchpad/*.mdsource files (plus theagents/subdirectory) for the marketing/subjective vocabulary targeted by prior runs:powerful,seamless,leverage,comprehensive,extensive,enhanced,deep,robust,intuitive,effortless,first-class,out-of-the-box,battle-tested,production-ready,magic,easy/easily,simple/simply, and related intensifiers.powerful,seamless,world-class, etc.): 0 violations in source files — all matches were eitherdev.mdchangelog quotes of past fixes or literal identifiers (unlockcommand/script names).gracefully(e.g. "handles errors gracefully", "gracefully degrades"): retained — standard engineering vocabulary, never flagged by prior runs.enhanced: most matches are code identifiers (EnhanceError), proposal section headings, or before/after config deltas with a stated baseline — left as descriptive language.deep: most matches are technical (nesting depth, "deep debugging") — only theengine-review-summary.mdH1 was a genuine leftover.Two confirmed fixes
The two changes above are the only confirmed subjective-intensifier issues. The
engine-review-summary.mdH1 fix resolves an inconsistency left by the v9.13 run, which corrected the same word in the file body but missed the title.Coverage
dev.mdRelated Documentationlink forengine-review-summary.mdalready omits the adjective, so the H1 rename introduces no link mismatch.Historical comparison
Trend: issue counts are declining as the corpus stabilizes; recent runs increasingly find leftovers from earlier partial fixes rather than fresh marketing language.
Next Steps
scratchpad/dev.md(v9.15).A pull request with these changes has been opened from branch
docs/consolidate-dev-instructions-20260530.Beta Was this translation helpful? Give feedback.
All reactions