Skip to content

Docs: Add Table of Contents (TOC) to README for Better Navigation #933

@prernaajaypatil-oss

Description

@prernaajaypatil-oss

Users must manually scroll through a lengthy README to find relevant sections such as:
Features
Quick Start
API Reference
Project Structure
Running Tests
Deployment
Observability
Optional LLM Integration
Configuration Reference
Tech Stack
Contributing
Roadmap
License
This can make onboarding and information discovery less efficient.

Proposed Solution
Add a dedicated Table of Contents section near the top of the README that includes anchor links to all major sections.

Example:
What is QyverixAI?
Preview
Features
Quick Start
API Reference
Project Structure
Running Tests
Deployment
Observability
Optional LLM Integration
Configuration Reference
Tech Stack
Contributing
Roadmap
License

Benefits
Improves documentation navigation.
Enhances contributor onboarding experience.
Makes the README more professional and user-friendly.
Reduces time spent searching for information.

Expected Outcome
A well-structured and fully functional Table of Contents that allows users to jump directly to any major section of the README.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions