docs: add AGENTS.md with repo conventions and writing style#2
Open
reneaaron wants to merge 4 commits into
Open
docs: add AGENTS.md with repo conventions and writing style#2reneaaron wants to merge 4 commits into
reneaaron wants to merge 4 commits into
Conversation
Adds an AGENTS.md at the repo root so AI coding agents (Claude Code, Cursor, Copilot, Codex, Aider) have a single place to learn how this repo is structured, how to make changes safely, and how to match the existing voice. Covers: - working rules (renames need redirects, SUMMARY is canonical, etc.) - writing style and tone — friendly, second-person, low on cheerleading - a short GitBook syntax cheat sheet for the blocks we actually use - a pointer to the upstream gitbook skill for the full reference CLAUDE.md is a symlink to AGENTS.md so Claude Code picks it up via its own convention without duplicating content. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
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.
Summary
Adds an
AGENTS.mdat the repo root so AI coding agents (Claude Code, Cursor, Copilot, Codex, Aider) have a single place to learn:SUMMARY.mdis canonical, renames need redirects in.gitbook.yaml, etc.{% hint %},{% tabs %},{% stepper %},{% content-ref %}, etc.)CLAUDE.mdis a symlink toAGENTS.mdso Claude Code picks it up via its native convention without duplicating content.🤖 Generated with Claude Code