Skip to content
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

Use mkdocs features to avoid manually configuring nav: #1698

Open
Tracked by #1677
butler54 opened this issue Sep 12, 2024 · 0 comments
Open
Tracked by #1677

Use mkdocs features to avoid manually configuring nav: #1698

butler54 opened this issue Sep 12, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@butler54
Copy link
Collaborator

Issue description / feature objectives

Manually configuring nav: for mkdocs is an anti-pattern. It creates inconsistency and removes part of the value of mkdocs - implicit naming based on directory structures.

Rework the automation specifically for the api docs and use mkdocs-awesome-pages to create selective overrides for just what is required.

Caveats / Assumptions

  • Documentation content should not be changed

Completion Criteria

  • nav: is removed
  • content is not changed
@jpower432 jpower432 added the documentation Improvements or additions to documentation label Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Ready
Development

No branches or pull requests

2 participants