From ebaba8cd5fae90c97089b7b8120bdd407d28e310 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Mon, 19 Oct 2026 11:14:02 +0300 Subject: [PATCH 1/2] docs: label the home page "cpp-linter-action" in the navigation again #504 gave docs/index.md the front-matter title "clang-format and clang-tidy GitHub Action" for the browser . MkDocs also uses that title as the page's navigation label, so the sidebar on every page and the footer's "Previous" link on Inputs and Outputs showed the long title (wrapping to two lines in the sidebar) instead of "cpp-linter-action". An explicit nav label restores the short name, as clang-tools-pip does. Material still builds <title> from the front matter, so the home page <title> and meta description are unchanged, and the nav keeps all its entries. --- mkdocs.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index b00af67f..931de336 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,7 +8,9 @@ edit_uri: "edit/main/docs/" exclude_docs: | overrides/ nav: - - index.md + # An explicit label: the home page's front-matter title is the longer, search-facing + # "clang-format and clang-tidy GitHub Action", which only <title> should use. + - cpp-linter-action: index.md - inputs-outputs.md - pr-review-caveats.md - permissions.md From d509a076efb9573bcde9d57baa7aa48f66ef8d89 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com> Date: Mon, 19 Oct 2026 18:17:12 +0000 Subject: [PATCH 2/2] docs: give the home page a real title instead of a description The front-matter title from #504, "clang-format and clang-tidy GitHub Action", described the action rather than naming the page, and MkDocs uses it as the home page's nav label too. Use the action's name as the title and move the descriptive wording into the meta description. The explicit nav label from the previous commit is no longer needed. --- docs/index.md | 4 ++-- mkdocs.yml | 4 +--- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/index.md b/docs/index.md index 93387793..97947522 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ --- -title: clang-format and clang-tidy GitHub Action -description: Run clang-format and clang-tidy on the C/C++ files a pull request changes, with annotations, review suggestions and a thread comment. +title: cpp-linter-action +description: A GitHub Action that runs clang-format and clang-tidy on the C/C++ files a pull request changes, with annotations, review suggestions and a thread comment. --- [file-annotations]: inputs-outputs.md#file-annotations diff --git a/mkdocs.yml b/mkdocs.yml index 931de336..b00af67f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,9 +8,7 @@ edit_uri: "edit/main/docs/" exclude_docs: | overrides/ nav: - # An explicit label: the home page's front-matter title is the longer, search-facing - # "clang-format and clang-tidy GitHub Action", which only <title> should use. - - cpp-linter-action: index.md + - index.md - inputs-outputs.md - pr-review-caveats.md - permissions.md