Skip to content

Automate Table of Contents generation in documentation using Doctoc #1308

@alok-kumar0421

Description

@alok-kumar0421

Summary

Currently, the Table of Contents within CONTRIBUTING.md is maintained manually.
This leads to the following problems:

  • TOC can become outdated when sections change
  • Contributors need to update it manually
  • Higher chance of inconsistency across documentation files

Introducing an automated TOC generator will make updates consistent and reduce maintenance overhead.

Proposed Solution

Integrate Doctoc (or an equivalent tool) into the documentation workflow to automatically generate and update Table of Contents sections.

Specifically:

  • Add Doctoc configuration for Markdown files where TOC is needed
  • Introduce a script or command (e.g., npm run generate-toc or similar)
  • Ensure TOC updates are applied during local development or CI
  • Document the usage for contributors in CONTRIBUTING.md

Benefits

  • Eliminates human error while updating TOC
  • Keeps documentation consistent and maintainable
  • Improves contributor experience
  • Reduces review overhead for PRs touching documentation

Additional Notes

This issue is a follow-up improvement related to the recent update to CONTRIBUTING.md TOC.
If approved, I would be happy to work on implementing this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions