Imported from kunchenguid/no-mistakes (
.agents/skills/documentation-guidance/SKILL.md). Install upstream withnpx skills add kunchenguid/no-mistakes --skill documentation-guidance. Copyright stays with the author.
Documentation
- Keep
README.mdconcise and high-level; the bar needs to be extremely high for what shows up there. - Most documentation lives in
docs/, the published docs site. - One owner per fact:
docs/src/content/docs/reference/global-config.mdanddocs/src/content/docs/reference/repo-config.mdown configuration keys,docs/src/content/docs/reference/environment.mdowns environment variables and the telemetry local/remote split,docs/src/content/docs/concepts/daemon.mdowns the daemon lifecycle model, and guides pages explain purpose and link to those owners instead of restating tables and examples. - The
document.instructionsblock in.no-mistakes.yamlstates this ownership map for the pipeline's document step; update it when ownership moves.
Agent-Guidance Surfaces
skills/no-mistakes/SKILL.mdis generated: the source of truth is thebodyconstant ininternal/skill/skill.go. Edit the body, thenmake skill;make lintfails CI on drift. Never editSKILL.mddirectly.no-mistakes initships this rendering to agents at user level.- Agent-driving guidance is owned by the skill body and the live
axioutput strings (internal/cli/axi*.go);docs/src/content/docs/guides/agents.mdcarries only the canonical invariant sentences pinned byinternal/cli/axi_guidance_test.goplus a pointer to the skill. When you change driving guidance, change the skill body and the point-of-useaxistrings together; that drift test is the sync check. - The shared default test-quality rule lives in
internal/testguidance; render it only into the task-first skill and pipeline roles that can author, repair, or review tests. Its fake-agent prompt tests are the intentional generated-interface contract, not source-text checks. - Review auto-fix is disabled by default (
auto_fix.review: 0inconfig.goautoFixDefaults), so blocking and ask-user review findings park for an agent decision; keep the skill, the liveaxigatenote, and docs qualified if you touch review auto-fix.
Combined Document+Lint Housekeeping Pass
- When
commands.lintis empty, the document step performs both duties in one agent invocation and stashes the lint half onRunShared(consume-once); the lint step consumes it instead of paying a second cold pass. Neither duty is ever silently dropped: a skipped pass, untrusted structured output, or a lint fix round falls back to lint's own agent pass. Configuredcommands.lintstays a first-class deterministic gate. Uncategorized findings fail safe to the stricter documentation gate. - The document prompt enforces the placement policy (one owner per fact, stale duplicates become pointers, no AGENTS.md postmortems, scope limited to docs the change made stale). Do not reintroduce exhaustive-corpus-sweep language; it caused doc commits in 90 of 121 audited PRs. Contract test:
TestDocumentStep_PromptAppliesPlacementPolicy; behavior tests:internal/pipeline/steps/housekeeping_test.go. agent.MemoryFilesRule(internal/agent/memory_files.go) limits independently initiated memory-file edits without excluding memory-file changes from review or prompted fixes. It is appended to the review/test/lint/PR/intent prompts and throughfixerPromptto shared fix turns and CI repair; rebase/merge conflict resolvers useagent.MemoryFilesConflictRule, and the document prompt has its own correction-only rule. Seedocs/src/content/docs/reference/pipeline-steps.mdfor the user-facing contract. Prompt-contract tests:internal/pipeline/steps/memory_files_test.go,internal/intent/*_test.go.
