Skip to content

Commit

Permalink
Re #4252 Change online table of contents
Browse files Browse the repository at this point in the history
  • Loading branch information
mpilgrem committed Nov 13, 2022
1 parent 51d16b2 commit 1dd8945
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 35 deletions.
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,18 +154,18 @@ description of a file in the menu can differ from the file's name. The
navigation menu allows files to be organised in a hierarchy. Currently, up to
three levels are used. The top level is:

* **Home:** The introduction to Stack. This page aims to be no longer than
* **Welcome!:** The introduction to Stack. This page aims to be no longer than
necessary but also to not assume much existing knowledge on the part of the
reader. It provides a 'quick start' guide to getting and using Stack.
* **Tool documentation:** How to get and use Stack. This includes Stack's user's
guide, the answers to frequently asked questions, and more thorough
explanations of aspects of Stack. The user's guide is divided into two parts.
The first part is 'introductory', and has the style of a tutorial. The second
part is 'advanced', and has more of a reference style.
* **Advanced documentation:** Stack's internal workings. Many users will not
need to consult this documentation.
* **Project documentation:** Information useful to people contributing to, or
maintaining, Stack's code and documentation.
* **How to get & use Stack:** This includes Stack's user's guide, answers to
frequently asked questions, and more thorough explanations of aspects of
Stack. The user's guide is divided into two parts. The first part is
'introductory', and has the style of a tutorial. The second part is
'advanced', and has more of a reference style.
* **How Stack works (advanced):** Many users will not need to consult this
advanced documentation.
* **Stack's code (advanced):** Other information useful to people contributing
to, or maintaining, Stack's code, documentation, and other files.
* **Signing key:** How Stack's released executables are signed.
* **Glossary:** A glossary of terms used throughout Stack's in-tool and online
documentation. We aim to describe the same things in the same way in different
Expand Down
52 changes: 27 additions & 25 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,32 +22,34 @@ extra_javascript:
- 'https://code.jquery.com/jquery-3.6.1.min.js'

nav:
- Home: README.md
- Tool documentation:
- Install/upgrade: install_and_upgrade.md
- User's guide (introductory): GUIDE.md
- User's guide (advanced): GUIDE_advanced.md
- FAQ: faq.md
- Configuration (project and global): yaml_configuration.md
- Snapshot and package location: pantry.md
- Snapshot specification: custom_snapshot.md
- stack.yaml vs a Cabal file: stack_yaml_vs_cabal_package_file.md
- Build command: build_command.md
- Code coverage: coverage.md
- REPL environment: ghci.md
- Dependency visualization: dependency_visualization.md
- Docker integration: docker_integration.md
- Nix integration: nix_integration.md
- Non-standard project initialization: nonstandard_project_init.md
- Stack and Visual Studio Code: Stack_and_VS_Code.md
- Developing on Windows: developing_on_windows.md
- Shell auto-completion: shell_autocompletion.md
- Travis CI: travis_ci.md
- Azure CI: azure_ci.md
- Lock files: lock_files.md
- Advanced documentation:
- Welcome!: README.md
- How to get & use Stack:
- General guidance:
- Install/upgrade: install_and_upgrade.md
- User's guide (introductory): GUIDE.md
- User's guide (advanced): GUIDE_advanced.md
- FAQ: faq.md
- Specific topics:
- Configuration (project and global): yaml_configuration.md
- Snapshot and package location: pantry.md
- Snapshot specification: custom_snapshot.md
- stack.yaml vs a Cabal file: stack_yaml_vs_cabal_package_file.md
- Build command: build_command.md
- Code coverage: coverage.md
- REPL environment: ghci.md
- Dependency visualization: dependency_visualization.md
- Docker integration: docker_integration.md
- Nix integration: nix_integration.md
- Non-standard project initialization: nonstandard_project_init.md
- Stack and Visual Studio Code: Stack_and_VS_Code.md
- Developing on Windows: developing_on_windows.md
- Shell auto-completion: shell_autocompletion.md
- Travis CI: travis_ci.md
- Azure CI: azure_ci.md
- Lock files: lock_files.md
- How Stack works (advanced):
- Build overview: build_overview.md
- Project documentation:
- Stack's code (advanced):
- Contributors:
- Contributor's guide: CONTRIBUTING.md
- Maintainers:
Expand Down

0 comments on commit 1dd8945

Please sign in to comment.