Skip to content

[skip changelog] Fix issues with command reference section of the documentation's navigation pane #801

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

Merged
merged 2 commits into from
Jul 8, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jul 8, 2020

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • The PR follows our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce?

Documentation fix.

  • What is the current behavior?
  • Incorrect name for the arduino-cli command is shown in the command reference section of the documentation's navigation pane.
  • arduino-cli burn-bootloader is missing from the command reference section of the documentation's navigation pane.
  • What is the new behavior?

Command reference section of the documentation's navigation pane correctly shows all commands.

  • Does this PR introduce a breaking change?

No.

per1234 added 2 commits July 8, 2020 01:56
When no title is defined, the documentation system automatically generates a title from the filename. This resulted in the command being incorrectly called "Arduino cli" in the command reference section of the documentation's navigation pane.
It's required to add an entry to mkdocs.yml before the command will be shown in the command reference section of the documentation's navigation pane.
@per1234 per1234 added the topic: documentation Related to documentation for the project label Jul 8, 2020
@per1234 per1234 merged commit c016eea into arduino:master Jul 8, 2020
@per1234 per1234 deleted the docs-nav-fixes branch July 8, 2020 10:36
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants