From 4a395177b4927b84d4c6de95bf708929a584acf2 Mon Sep 17 00:00:00 2001 From: Guangya Liu Date: Fri, 17 Jan 2025 10:34:57 -0500 Subject: [PATCH] [chore] Added content for update toc (#1754) Signed-off-by: Guangya Liu --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 111d35baa..68755d1cf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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) @@ -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 @@ -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: