Repository navigation
docs(agents): document the FAQ folder and where a question belongs - #188
Merged
Merged
Conversation
docs/faq/ landed in #187 but AGENTS.md never mentioned it, so an agent reading the canonical guide would not know it exists and would answer the same question again somewhere else. Three additions: - The repository-structure tree now lists docs/faq/ beside docs/release-notes/. - Documentation conventions gain the rule: a question someone will ask again gets its own file in docs/faq/ plus a row in the index. Phrase the heading as the question a reader types, not as the name the code uses, and do not restate a setup or reference page. Where a fact could sit in both, pick one owner -- docs/codex-setup.md owns installing and configuring codex, the FAQ owns the per-path recipes. - The reference-doc list points at docs/faq/, and the write-it-down rule at the end of that section now names the FAQ as a destination alongside the model guide and the setup doc. Every relative link in AGENTS.md resolves.
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.
docs/faq/landed in #187 but AGENTS.md never mentioned it. An agent reading the canonical guide would not know the folder exists, and would answer the same question somewhere else instead of adding to it.Three additions, all to AGENTS.md:
docs/faq/besidedocs/release-notes/, with its shape: one file per question plus an index.docs/faq/, add a row to the index, phrase the heading as the question a reader types rather than the name the code uses, and do not restate a setup or reference page. Where a fact could sit in both, pick one owner:docs/codex-setup.mdowns installing and configuring codex,docs/faq/wiring-codex-to-models.mdowns the per-path recipes.Every relative link in AGENTS.md resolves (checked programmatically).
After this merges the
0.2.0tag moves to the new merge commit, so the tag ships the notes plus every doc that describes the release.