-
Notifications
You must be signed in to change notification settings - Fork 0
docs: address copilot feedback (ToC links, hierarchy, config cleanup) #15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR addresses documentation feedback by updating the Table of Contents links, fixing heading hierarchy, and cleaning up configuration examples.
Changes:
- Updated ToC links for Install, Configure, Run, and Docker sections
- Changed "CLI" to "Commands" in ToC
- Removed duplicate
EMAIL_KEYfrom environment variable example - Fixed heading hierarchy for "Extensible by design" section
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - [Configuration](#configuration) | ||
| - [CLI](#cli) | ||
| - [Commands](#commands) | ||
| - [Plugins](#plugins) |
Copilot
AI
Jan 19, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These ToC links won't work because they reference anchors that don't exist. The targets 2. **Install**, 3. **Configure**, and 4. **Run** are numbered list items under the "Manual Setup" section, not markdown headings. Markdown only generates anchor links from headings (lines starting with #).
Consider either: (1) converting these list items to proper headings (e.g., ### 2. Install), or (2) updating the ToC to link to the parent section #manual-setup instead, or (3) removing these ToC entries since they're sub-items of the Quickstart section.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #15 +/- ##
=======================================
Coverage 72.77% 72.77%
=======================================
Files 59 59
Lines 4849 4849
=======================================
Hits 3529 3529
Misses 1320 1320 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Address feedback from #9