Deduplicate agent docs and READMEs, fix stale docs - #323
Merged
Merged
Conversation
Each fact now lives in one place: AGENTS.md files route to README, PRODUCT, DESIGN and THEME instead of restating them. Removes references to the generator (deleted in 2020) and its broken `generate` script, and corrects docs that drifted from the code (web port, env injection, OpenAPI docs flow, fonts, brand defaults, missing file paths).
API ChangesNo changes. |
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.
What
AGENTS.mdnow route toREADME.md/PRODUCT.md/DESIGN.md/THEME.mdinstead of restating toolchain, stack, commands, design rules or product description. Service READMEs link to the root README for Volta/pnpm setup.generatordirectory hasn't existed since 2020. Dropped it fromAGENTS.md,PRODUCT.md,DESIGN.md(Parity Rule), the API README (bedrock generate docs) and the brokengeneratescript inservices/web/package.json.SERVER_PORTdefault is2200, not2300window.__ENV__, notwindow.__env_confindex.htmlis the entry point (notsrc/index.html);serve/dev.jsdoesn't existopenapi.json+pnpm docs:generate+ MDX pages (notsrc/routes/__openapi__)Reviewer notes
pnpm docs:generateor the app.credentials.conf, which Git ignores on purpose.