docs: rework project documentation for clarity and navigation#10
Merged
AndrewAltimit merged 1 commit intomainfrom Mar 3, 2026
Merged
docs: rework project documentation for clarity and navigation#10AndrewAltimit merged 1 commit intomainfrom
AndrewAltimit merged 1 commit intomainfrom
Conversation
Rewrite README.md following the template-repo documentation style: - Add concise project description and "Use this repo to learn" section - Replace oversized OpenAI security section with a brief notice - Add Quick Start with build commands - Use proper tree characters in diagrams - Add richer crate descriptions with technical details - Add Documentation index table linking all docs - Add Companion Repository reference to template-repo - Link to GitHub Pages site Clean up satellite docs: - AGENTS.md: remove inline Codex security note from CI section - CONTRIBUTING.md: remove specific agent names (Codex reference) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
Test plan
Generated with Claude Code