docs: consolidate root docs (fold BOUNDARIES, fix doc maps) - #177
Merged
Conversation
Fold BOUNDARIES.md into ARCHITECTURE.md (new Customization Boundaries section) and delete it. Fill the AGENTS.md Versioning section (links CHANGELOG.md). Fix the AGENTS.md and README.md doc maps: drop the BOUNDARIES row, add COMPONENTS / CHANGELOG / SECURITY, dedupe the README Components label. Replace stray em dashes with hyphens/colons in the touched docs.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Phase 4 of the docs consolidation.
BOUNDARIES.mdintoARCHITECTURE.mdas a new "Customization Boundaries" section, and delete the standalone file (it was 64 lines of build-vs-extend philosophy that belongs with architecture).AGENTS.mdVersioning section (was a TODO placeholder from docs: consolidate engineering standards into AGENTS.md #175) with the semver-for-a-template policy summary, linkingCHANGELOG.md.AGENTS.mdandREADME.md: drop the now-goneBOUNDARIES.mdrow, addCOMPONENTS.md/CHANGELOG.md/SECURITY.md, and dedupe the README "Components" label (inventory vs UI reference).Test plan
bun run checkgreenBOUNDARIES.mdreferences anywhereREADME.md/ARCHITECTURE.md/AGENTS.md