Skip to content

Add doctoc to automatically generate TOCs #326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jul 17, 2024
Merged

Add doctoc to automatically generate TOCs #326

merged 1 commit into from
Jul 17, 2024

Conversation

lucacome
Copy link
Contributor

Proposed changes

The Contributing Guidelines had new sections that were never added to the TOC.

With doctoc we can keep the TOCs up to date automatically.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@lucacome lucacome requested a review from a team as a code owner July 17, 2024 00:43
@github-actions github-actions bot added documentation Pull requests/issues for documentation chore Pull requests for routine tasks labels Jul 17, 2024
@lucacome lucacome merged commit d00d5c8 into main Jul 17, 2024
13 checks passed
@lucacome lucacome deleted the chore/add-toc branch July 17, 2024 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vepatel vepatel vepatel approved these changes

Assignees
No one assigned
Labels
chore Pull requests for routine tasks documentation Pull requests/issues for documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lucacome @vepatel