From e40c3d9db823a2ec0d31aa2210a0ca93253dc170 Mon Sep 17 00:00:00 2001 From: Tim Monko Date: Wed, 13 Aug 2025 01:31:05 -0500 Subject: [PATCH] add toc --- docs/gh_repo_settings.md | 4 ++-- mkdocs.yml | 10 ++++++++++ 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/gh_repo_settings.md b/docs/gh_repo_settings.md index b392919..59038ed 100644 --- a/docs/gh_repo_settings.md +++ b/docs/gh_repo_settings.md @@ -4,7 +4,7 @@ Use pull requests for all changes to the codebase. Not only does this make changes safer, especially with regards to CI checks, but it also provides a clear history of changes made to the codebase. This is particularly useful for understanding the evolution of the code because it allows you to see what changes were made, when, and by whom. More than just `git blame`, many IDEs provide a way to view the history of the PR, including the discussions and commits that led to the final merged PR. This is invaluable not only for remembering your own work, but for documenting the codebase for others. *Even if you are working on a project alone, using a PR approach will prove invaluable at times.* -## General Repo Settings +## Opinionated Repo Settings Use only Squash and Merge to keep a clean commit history. Use PR title and description to document the merge commit. Again, blame will allow you to find the PR and its discussion. @@ -13,7 +13,7 @@ Use only Squash and Merge to keep a clean commit history. Use PR title and descr You may also like: - Always suggest updating pull request branches: Adds a button to update a PR with content from main -- useful for new contributors. -- Automaticly delete head branches: Automatically deletes the branch after merging a PR. +- Automatically delete head branches: Automatically deletes the branch after merging a PR. ## Branch Protection Rules diff --git a/mkdocs.yml b/mkdocs.yml index a524e74..b5cca72 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,6 +3,16 @@ site_url: https://timmonko.github.io/urssi-docs/ theme: name: material +nav: + - Overview: index.md + - Docs Deployment: docs_setup.md + - Repository Documentation: repo_setup.md + - GitHub Repo Settings: gh_repo_settings.md + - Documenting Code: docstrings.md + - Notebooks: notebooks.ipynb + - Versioning: versioning.md + + markdown_extensions: - admonition