Skip to content

Commit

Permalink
feat: enable mkdocs instant navigation feature
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Jul 8, 2024
1 parent 87ccce1 commit 4b57c8a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/dev-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,16 @@ software development practices.
> If there are, consider breaking them down to smaller tasks.
- The quality control status can be tracked:

- `qa:ready`: the issue has been fixed and is ready to test.
- `qa:fail`: the issue was not fixed as intended and requires additional
work from the developer.
- The `qa:xx` label can be removed when an issue is closed.

- Issues marked `good first issue` are approachable to newcomers in the repo.
- Ideally the repo should always have a few low priority `good first issue`
tags to help foster open source contribution / onboarding.

#### Issue Assignment

- Assign issues to the dev who will work on it.
Expand Down
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ theme:
favicon: assets/images/favicon.png
logo: assets/images/hot_logo.png
# custom_dir: docs/overrides
features:
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress

extra_css:
- css/extra.css
Expand Down

0 comments on commit 4b57c8a

Please sign in to comment.