Skip to content

[Docs] Add a multi-column README table of contents - #96

Merged
sonukapoor merged 1 commit into
mainfrom
feature/issue-95-readme-toc
Apr 4, 2026
Merged

sonukapoor merged 1 commit into
mainfrom
feature/issue-95-readme-toc

Conversation

@sonukapoor

Copy link
Copy Markdown
Collaborator

Summary

Add a compact multi-column table of contents near the top of the README.

Closes #95.

What Changed

  • added a new Contents section near the top of the README
  • used a compact four-column HTML table for navigation
  • linked the major sections only, rather than every subsection

Why

The README has grown substantially, and a top-level table of contents makes it easier for readers to jump directly to overview, usage, workflow, comparison, and project sections.

Verification

  • docs-only content review

@sonukapoor
sonukapoor force-pushed the feature/issue-95-readme-toc branch from 4a021f4 to 4a3ca34 Compare April 4, 2026 23:24
@sonukapoor
sonukapoor merged commit 22dedcd into main Apr 4, 2026
4 checks passed
@sonukapoor
sonukapoor deleted the feature/issue-95-readme-toc branch April 4, 2026 23:25
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.

[Docs] Add a multi-column table of contents to the README

1 participant