| commit | 8c954ec2ec1f5060301e8884204447873cec4c4e | |
| author | Malte Neuss <malteneuss@users.noreply.github.com> | |
| Sat, 28 Oct 2023 21:04:37 +0000 (28 23:04 +0200) | ||
| committer | Mikolaj <281893+Mikolaj@users.noreply.github.com> | |
| Sun, 5 Nov 2023 20:59:50 +0000 (5 20:59 +0000) | ||
| tree | 178b63ca690c15bbc3d310c44a9b315a6cce1803 | treesnapshot (tar.gz zip) |
| parent | 7691c45361f645a3339a336eaf8563ee8365c4c7 | commitdiff |
Restructure Cabal documentation top-level parts
The goal is for users to easier find pages for typical problems through search engines and page navigation.
- The top-level layout is based on the popular documentation structure by https://documentation.divio.com/ to give a
clear structure to users and future documentation contributors:
* Guides: Present a solution to a single, atomic, typical user problem.
* Reference: Describe user API (CLI fields, syntax etc) with technical rigour and completeness.
* Explanation: Discuss background information, scope, design decisions etc.
- Move existing documentation roughly into these categories with minimal editing as the basis for further editing.
- Rename guide titles to mention how-to for improving SEO.
- Rename some files to improve SEO since that name becomes part of the URL (often called slug).
Important page keywords should appear in the slug as well to make pages rank higher in search engines.
The goal is for users to easier find pages for typical problems through search engines and page navigation.
- The top-level layout is based on the popular documentation structure by https://documentation.divio.com/ to give a
clear structure to users and future documentation contributors:
* Guides: Present a solution to a single, atomic, typical user problem.
* Reference: Describe user API (CLI fields, syntax etc) with technical rigour and completeness.
* Explanation: Discuss background information, scope, design decisions etc.
- Move existing documentation roughly into these categories with minimal editing as the basis for further editing.
- Rename guide titles to mention how-to for improving SEO.
- Rename some files to improve SEO since that name becomes part of the URL (often called slug).
Important page keywords should appear in the slug as well to make pages rank higher in search engines.
17 files changed: