docs: add documentation index#3
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a canonical documentation entry point under docs/ to centralize where documentation starts, while avoiding dead links by only linking to existing content.
Changes:
- Introduces
docs/index.mdas the documentation landing page. - Links to the root
README.mdfor installation/usage details and lists future doc topics as non-links.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
docs/index.mdas the canonical documentation entry point.README.mdand leaves future docs topics as plain text to avoid dead links.Build Arena provenance
doc.index.missing.docs/index.mdonly.Verification
test -e docs/index.md✅../README.md) ✅uv run --extra dev python -m pytest -q✅ 19 passeduv run --extra dev ruff check src/ tests/✅uv run --extra dev mypy src/✅git diff --cached --check✅No canonical checkout edits were made during Build Arena proposal generation; this PR packages the approved worktree proposal.