CL-6509: Docs cleanup — sharpen AGENTS.md, fix stale DESIGN.md rail - #260
Merged
Conversation
AGENTS.md gains a checked-conventions section for the error-sink, browser-safe-subpaths, tool-package-pins, and licenses gates plus the exactOptionalPropertyTypes gotcha, all of which have cost real debugging time; the docs map now lists PRODUCT/ARCHITECTURE/ IMPLEMENTATION. DESIGN.md's footer-rail description is updated now that Mission Control and Evals have both shipped.
5 tasks
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
reportErrorfrom@corbits/error-sink,check:browser-safe-subpaths,check:tool-package-pins(and its known gap onsrc/changing without a bump),check:licenses, and theexactOptionalPropertyTypesabsent-vs-undefined gotcha. Also notes that a fresh worktree'spackages/is the source of truth, notnode_modules, beforebun installruns./mission-control,/evalsincluded).vendor/intx/hub-apiis still an open PR (Workflow deploy: close the bearer-auth gap for agent-authored workflows #258), not merged — no ledger update needed yet.No wholesale rewrite, no new process, no aspirational rules — this only documents conventions already enforced by an existing check script or already true in shipped code, and cuts/sharpens stale text.
Linear: CL-6509
Test plan
bunx prettier --check AGENTS.md DESIGN.md(already run locally, no diff)