Skip to content

docs: add table of contents to README#363

Open
prernaajaypatil-oss wants to merge 2 commits into
sudip-mondal-2002:mainfrom
prernaajaypatil-oss:docs/table-of-contents
Open

docs: add table of contents to README#363
prernaajaypatil-oss wants to merge 2 commits into
sudip-mondal-2002:mainfrom
prernaajaypatil-oss:docs/table-of-contents

Conversation

@prernaajaypatil-oss

@prernaajaypatil-oss prernaajaypatil-oss commented Jun 9, 2026

Copy link
Copy Markdown

What does this PR do?

Added a comprehensive Table of Contents to the README to improve navigation and accessibility.

Changes Made

  • Added TOC near the top of README
  • Included links to all major sections and subsections
  • Improved navigation for contributors and users

Related Issue

Fixes #362

Type of Change

  • 🐛 Bug fix
  • ✨ New feature
  • ♻️ Refactor / code cleanup
  • 📝 Documentation
  • ✅ Tests
  • 🔧 Build / CI / Configuration

How Was This Tested?

  • Platform(s) tested on:
  • Test command run: ./amplitron-tests
  • Manual test steps (if applicable):

Checklist

  • Code compiles and builds successfully on my platform
  • All existing tests pass (./amplitron-tests)
  • New tests added for new functionality (if applicable)
  • Documentation updated (README, code comments) if applicable
  • No blocking calls on the audio thread (no std::mutex::lock() on the hot path)
  • Tested on: (list your OS/platform)

Screenshots / Demo

Summary by CodeRabbit

  • Documentation
    • Added a Table of Contents near the top of the README with anchor links to major sections: platform downloads, demo video, features, hardware setup, building from source, usage, project structure, architecture, troubleshooting, development/contributing, and license.

@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3494234b-1ecf-4f2c-ba4c-7107fc563110

📥 Commits

Reviewing files that changed from the base of the PR and between 97379ab and f8bb1be.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

The PR adds a clickable Table of Contents to the README listing anchor links to major documentation sections (platform downloads, demo video, features, hardware setup, building from source, usage, project structure, architecture, troubleshooting, development/contributing, and license) placed near the top before "Platform Downloads."

Changes

Documentation Navigation

Layer / File(s) Summary
Table of Contents insertion
README.md
Added a new Table of Contents section with nested markdown links to major README section headings, positioned after the project introduction.

Estimated Code Review Effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit hops through docs so wide,
Leaves a trail of links to be your guide,
Click a line and skip the scroll,
Find what you need, reach your goal,
🐰📚

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title clearly and concisely describes the main change: adding a table of contents to the README documentation.
Linked Issues check ✅ Passed The PR successfully implements all requirements from issue #362: adds a TOC near the top of README with links to all specified major sections (Features, Hardware Setup, Building from Source, Usage, Project Structure, Architecture, Troubleshooting, Development & Contributing, License).
Out of Scope Changes check ✅ Passed All changes are directly related to issue #362 requirements; only the README.md file was modified to add the table of contents with no extraneous or unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 40: Update the TOC entry string to exactly match the heading text:
replace "Command-line Options" with "Command-line options" so the
table-of-contents entry and the heading text are identical; locate the TOC line
containing "Command-line Options" and change the capital 'O' to lowercase to
match the heading.
- Line 20: Update the README TOC to match heading casing: change the TOC entry
text `Command-line Options` to `Command-line options` so it exactly matches the
heading; leave the `- [Demo Video](`#-demo-video`)` entry as-is because the
emoji-derived slug is correct (matches the `## 🎬 Demo Video` heading).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3ca50cfd-6184-4a42-b500-c281472afc97

📥 Commits

Reviewing files that changed from the base of the PR and between 39100d0 and 97379ab.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
Comment thread README.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] Add a Table of Contents to improve README navigation

1 participant