Skip to content

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jul 20, 2023

The project documentation is published in a website generated by MkDocs.

The primary UI for discovering and accessing the various pages of the site is through the navigation panel/menu. In order to have control over the structure, the contents of the navigation element are explicitly defined in the nav key of the MkDocs configuration file:

https://www.mkdocs.org/user-guide/configuration/#nav

A new "Plugins" page was added to the documentation (#179). Previously that page was not included in the nav key so the page was not listed in the website's navigation element.

The navigation element before the changes proposed here:

image

and after:

image

The project documentation is published in a website generated by MkDocs.

The primary UI for discovering and accessing the various pages of the site is through the navigation panel/menu. In order to have control over the structure, the contents of the navigation element are explicitly defined in the `nav` key of the MkDocs configuration file.

A new "Plugins" page was added to the documentation. Previously that page it was not included in the `nav` key so the page was not listed in the website's navigation element.
@per1234 per1234 added topic: infrastructure Related to project infrastructure topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project labels Jul 20, 2023
@per1234 per1234 requested a review from alessio-perugini July 20, 2023 22:43
@per1234 per1234 self-assigned this Jul 20, 2023
Copy link
Contributor

@alessio-perugini alessio-perugini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thx

@alessio-perugini alessio-perugini merged commit 792e2e0 into arduino:main Jul 21, 2023
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 topic: infrastructure Related to project infrastructure type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants