By default, MkDocs uses the first page header as title for the navigation item.
You can diverge from that by using the following setup in the nav section: - 'some title': 'docs/some-file.md'
This is handy for some situations, for example when you want to create a menu item called 'Introduction' for a page but use a different page header like 'Welcome to the CLI docs'
However, in the CLI Docs, the title has always been added to the config yaml, leading to subtle divergences between menu item titles and page headers as an unwanted side effect.
The nav titles should ONLY be used when there is a specific reason to diverge from the page header.
This issue is solved when
🎯 All items in the navigation node of mkdocs.yml are referenced as - file.md, except those that have a need to diverge.
🎯 The following files have diverging titles. these need to be checked and possibly updated:
-
User Guides
For these user guides it's not nice if every navigation title includes the entire product name: CLI for Microsoft 365, I'd suggest the titles may diverge where necessary.
- user-guide/installing-cli.md - 'Install the CLI' differs from 'Install the CLI for Microsoft 365'
- user-guide/using-cli.md - 'Use the CLI in command line' differs from 'Use the CLI for Microsoft 365'
- user-guide/run-cli-in-docker-container.md - 'Run CLI in a Docker Container' differs from 'Run CLI for Microsoft 365 in a Docker Container'
- user-guide/cli-output-mode.md - 'CLI output mode' differs from 'CLI for Microsoft 365 output mode'
- user-guide/filter-cli-data.md - 'Filter CLI data' differs from 'Filter CLI data using JMESPath queries'
- user-guide/configuring-cli.md - 'Configure CLI' differs from 'Configure CLI for Microsoft 365'
- user-guide/github-actions.md - 'GitHub Actions' differs from 'Automate your CI/CD workflow using CLI for Microsoft 365 GitHub Actions'
- user-guide/manage-microsoft-365-apps.md - 'Manage Microsoft 365 apps with the CLI' differs from 'Manage Microsoft 365 apps'
- user-guide/use-cli-api.md - 'Use CLI programmatically' differs from 'Use CLI for Microsoft 365 programmatically'
-
Concepts:
for these, it's OK to correct the navigation title, so that it matches the page header.
- concepts/persisting-connection.md - 'Persisting connection' differs from 'Persisting connection information'
- about/team.md - 'Team' differs from 'Meet the Team'
-
Other issues:
- cmd/app/app-open.md - 'app open' differs from 'aad app open'
This one came out of the check as well. As it is wrong, it should be corrected.
🎯 In the mkdocs.yml file, use of the single quote is inconsistent. This should be corrected.
By default, MkDocs uses the first page header as title for the navigation item.
You can diverge from that by using the following setup in the nav section:
- 'some title': 'docs/some-file.md'This is handy for some situations, for example when you want to create a menu item called 'Introduction' for a page but use a different page header like 'Welcome to the CLI docs'
However, in the CLI Docs, the title has always been added to the config yaml, leading to subtle divergences between menu item titles and page headers as an unwanted side effect.
The nav titles should ONLY be used when there is a specific reason to diverge from the page header.
This issue is solved when
🎯 All items in the navigation node of
mkdocs.ymlare referenced as- file.md, except those that have a need to diverge.🎯 The following files have diverging titles. these need to be checked and possibly updated:
User Guides
For these user guides it's not nice if every navigation title includes the entire product name:
CLI for Microsoft 365, I'd suggest the titles may diverge where necessary.Concepts:
for these, it's OK to correct the navigation title, so that it matches the page header.
Other issues:
This one came out of the check as well. As it is wrong, it should be corrected.
🎯 In the
mkdocs.ymlfile, use of the single quote is inconsistent. This should be corrected.