docs: reference only tracked documents#1081
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Nine files referenced a repository-root document that is no longer version-controlled. Those references resolved for a checkout that happened to have the file and broke on a fresh clone — the same defect class the link gate exists to catch, in files the link gate does not read (TypeScript comments, a site build script). They now point at docs/engineering-practices.md, which is tracked and carries the same performance, visual-verification and pattern-canon guidance. The site's llms.txt generator was including that untracked root file in ROOT_FILES, so local configuration was being published to the website on every build. It now publishes README.md and CHANGELOG.md only. Removed the multi-agent build section from docs/engineering-practices.md and renumbered; its content is workflow configuration rather than engine guidance, and it does not belong in the engine's tracked documentation. Section cross-references verified after renumber. Deliberately untouched: the Field Agent Consumption Model vocabulary in packages/core/src/inspect/report.ts, and the AI-crawler list in the site's robots configuration. Both are domain content that a pattern-matched sweep would have damaged. typecheck clean; full suite passes; check:docs, check:readme, check:links green.
zachshallbetter
force-pushed
the
docs/reference-tracked-guidance
branch
from
July 20, 2026 19:53
5b7e908 to
bde0584
Compare
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
1 participant
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.
Purpose
Nine files referenced a repository-root document that is no longer version-controlled. Those references resolved for a checkout that happened to have the file and broke on a fresh clone — the same defect class the link gate exists to catch, in files the link gate does not read (TypeScript comments, a site build script).
Changes
docs/engineering-practices.md, which is tracked and carries the same performance, visual-verification and pattern-canon guidance.apps/site/scripts/gen-llms.mjswas publishing that untracked root file to the website viaROOT_FILESon every build. It now publishesREADME.mdandCHANGELOG.mdonly.docs/engineering-practices.mdand renumbered — it is workflow configuration, not engine guidance. Section cross-references verified after renumber.Deliberately untouched
packages/core/src/inspect/report.ts— domain concept, not tooling.ClaudeBot,anthropic-ai,PerplexityBot, …) — legitimate content about crawlers.A pattern-matched sweep would have damaged both.
Gates
typecheck · full suite ·
check:docs·check:readme·check:links— all green.