Skip to content

Conversation

@ntno
Copy link
Owner

@ntno ntno commented Dec 14, 2023

  • refactor sidenav to use recursion
  • add option to allow for deeper sidenav nesting
  • doc reorganization
  • breaking change version bump

TODO:

  • consider: add back in feature where an active page does not display as a clickable link in the sidenav
  • review documentation that refers to ^
  • unit tests
  • fix or write up TODO issue for the bug where there is an empty ul element
  • consider: prefix config.extra variables with mkdocs-terminal
    • consider: do they need to be caps?
  • update docs so that "navigation.side.indexes" is standard
  • remove references to "navigation.side.indexes" in code
  • check what happens if you give a regular page the title "Index" -> does it get skipped? should only get skipped if it is inside a section(?)

Description

Describe the purpose of this PR along with any background information and the impacts of the proposed change. For the benefit of the community, please do not assume prior context.

Provide details that support your chosen implementation, including: breaking changes, alternatives considered, changes to the API, etc.

If the UI is being changed, please provide before/after screenshots.

References

Include any links supporting this change such as a:

  • GitHub Issue/PR number addressed or fixed
  • Related pull requests/issues from other repos

If there are no references, simply delete this section.

Testing

Describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If there are existing unit and/or integration test suites, tests should be added for new functionality and existing tests should complete without errors.

Please include any manual steps for testing end-to-end or functionality not covered by unit/integration tests.

Also include details of the environment this PR was developed in (language/platform/browser version).

  • This change adds test coverage for new/changed/fixed functionality

Checklist

  • I have added documentation for new/changed functionality in this PR or in mkdocs-terminal/documentation
  • All active GitHub checks for tests, formatting, and security are passing

…enav nesting, doc reorganization, breaking change version bump
@ntno ntno changed the title DRAFT: enable section indexes by default, allow deeper nesting in sidenav WIP: enable section indexes by default, allow deeper nesting in sidenav Dec 14, 2023
@ntno
Copy link
Owner Author

ntno commented Dec 14, 2023

relates to #137

@ntno ntno marked this pull request as ready for review December 14, 2023 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants