Skip to content
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.

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

Remove TOC from README #567

Closed
davereid opened this issue May 7, 2024 · 2 comments · Fixed by #578
Closed

Remove TOC from README #567

davereid opened this issue May 7, 2024 · 2 comments · Fixed by #578
Assignees
Labels
enhancement New feature or request

Comments

@davereid
Copy link
Member

davereid commented May 7, 2024

We should have an automated way to catch if the README.md file is updated with new headings, but the automatic DocToc table of contents hasn't been changed.

Or alternatively, we could have a workflow that automatically adds a commit to the PR that fixes it automatically. https://github.com/marketplace/actions/toc-generator could potentially be used for this, but we would need to provide a GITHUB_TOKEN that is generated using our GitHub app so that workflows will run after the commit.

@davereid davereid added the enhancement New feature or request label May 7, 2024
@davereid davereid self-assigned this May 7, 2024
@justafish
Copy link
Member

@deviantintegral
Copy link
Member

Wow, that's totally new, and awesome! I'm fine with that, and teams using GitLab or Bitbucket can make their own decisions.

@justafish justafish changed the title Add a GitHub workflow that can automatically update TOCs in README files or fail if not updated locally. Remove TOC from README May 23, 2024
justafish added a commit that referenced this issue May 23, 2024
@justafish justafish assigned justafish and unassigned davereid May 23, 2024
justafish added a commit that referenced this issue May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants