You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "alok-kumar0421 (via GitHub)" <gi...@apache.org> on 2025/12/10 20:44:30 UTC

[I] Automate Table of Contents generation in documentation using Doctoc [airflow-site]

alok-kumar0421 opened a new issue, #1308:
URL: https://github.com/apache/airflow-site/issues/1308

   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.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [I] Automate Table of Contents generation in documentation using Doctoc [airflow-site]

Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on issue #1308:
URL: https://github.com/apache/airflow-site/issues/1308#issuecomment-3638901873

   This is a lot of AI generated text way more than the PR implementing it. I suggest next time just open PR and skip all that unnecessary boilerplate. it's a lot of noise that takes a lot of time. Don't do it next time please.
   
   But yes implement it please.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [I] Automate Table of Contents generation in documentation using Doctoc [airflow-site]

Posted by "choo121600 (via GitHub)" <gi...@apache.org>.
choo121600 commented on issue #1308:
URL: https://github.com/apache/airflow-site/issues/1308#issuecomment-3742650596

   this issue is solved in #1354
   so we can close this issue :)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [I] Automate Table of Contents generation in documentation using Doctoc [airflow-site]

Posted by "choo121600 (via GitHub)" <gi...@apache.org>.
choo121600 closed issue #1308: Automate Table of Contents generation in documentation using Doctoc
URL: https://github.com/apache/airflow-site/issues/1308


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [I] Automate Table of Contents generation in documentation using Doctoc [airflow-site]

Posted by "alok-kumar0421 (via GitHub)" <gi...@apache.org>.
alok-kumar0421 commented on issue #1308:
URL: https://github.com/apache/airflow-site/issues/1308#issuecomment-3638920072

   Thanks for the feedback
   I understand - I will keep future issues concise and to the point.
   Proceeding with the implementation now


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org