diff --git a/docs/dev-practices.md b/docs/dev-practices.md index c88b55f..2ac32d8 100644 --- a/docs/dev-practices.md +++ b/docs/dev-practices.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml index a7f37f8..5c33cf0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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