diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..7f7e4cdf7 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,23 @@ +# Jujutsu—a version control system + +## Welcome to `jj`'s documentation website! + + +The complete list of the documentation pages available is available in the +sidebar. + +Additional help is available using the `jj help` command if you have `jj` +installed. + +You may want to jump to: + +- Documentation for the [latest released version of `jj`](https://martinvonz.github.io/jj/latest). +- Documentation for the [unreleased version of `jj`](https://martinvonz.github.io/jj/prerelease). This version of the docs corresponds to the `main` branch of the `jj` repo. + +## Some useful links + +- [GitHub repo for `jj`](https://github.com/martinvonz/jj) +- Overview of `jj` in the repo's [README](https://github.com/martinvonz/jj?tab=readme-ov-file#jujutsu-vcs) +- [Installation and Setup](install-and-setup.md) +- [Tutorial and Birds-Eye View](tutorial.md) +- [Working with GitHub](github.md) diff --git a/mkdocs.yml b/mkdocs.yml index 8601d129e..76ac3d450 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,7 +15,6 @@ plugins: - search - redirects: redirect_maps: - 'index.md': 'install-and-setup.md' # Not all of these may be necessary, especially since the material # theme substitutes for some of them @@ -38,6 +37,8 @@ markdown_extensions: # This lists all the files that become part of the documentation nav: +- 'Home': 'index.md' + - 'Getting started': - 'Installation and Setup': 'install-and-setup.md' - 'Tutorial and Birds-Eye View': 'tutorial.md' diff --git a/pyproject.toml b/pyproject.toml index 527a35a6d..380d20fbb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -13,7 +13,7 @@ python = "^3.8" [tool.poetry.dev-dependencies] mkdocs = "^1.5.2" mkdocs-material = "^9.2.5" -# Makes `install-and-setup.md` open by default instead of `index.md`. +# Allows setting up redirects when renaming docs files mkdocs-redirects = "^1.2.1" # Versioning of documentation mike = "^1.1.2"