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

[chore] Added content for update toc #1754

Merged
merged 1 commit into from
Jan 17, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ requirements and recommendations.
- [Auto formatting](#auto-formatting)
- [Markdown style](#markdown-style)
- [Misspell check](#misspell-check)
- [Update the tables of content](#update-the-tables-of-content)
- [Markdown link check](#markdown-link-check)
- [Updating the referenced specification version](#updating-the-referenced-specification-version)
- [Making a Release](#making-a-release)
Expand Down Expand Up @@ -343,6 +344,7 @@ You can also run these fixes individually.
See:

- [Misspell Correction](#misspell-check)
- [Update the tables of content](#update-the-tables-of-content)
- [Update the markdown files](#2-update-the-markdown-files)

### Markdown style
Expand Down Expand Up @@ -389,6 +391,14 @@ To quickly fix typos, use
make misspell-correction
```

### Update the tables of content

To update the tables of content, run:

```bash
make markdown-toc
```

### Markdown link check

To check the validity of links in all markdown files, run the following command:
Expand Down
Loading