Copyedit tutorials, how-tos and reference pages structure
Marco Ricci commited on 2024-11-28 13:34:17
Zeige 5 geänderte Dateien mit 32 Einfügungen und 8 Löschungen.
Includes * index pages for the tutorials and how-tos sections * adding a "man page" section in the global navigation block * dropping the rendundant "tutorial" in the tutorial titles
- docs/how-tos/index.md 0000000..1db23ff
- docs/reference/index.md 832a033..0f9845c
- docs/tutorials/basic-setup-passphrase.md 7f7045f..694685e
- docs/tutorials/index.md 0000000..8dea878
- mkdocs.yml d9eb705..ef12244
| ... | ... |
@@ -9,7 +9,7 @@ title: Reference overview |
| 9 | 9 |
* [`derivepassphrase-export(1)`][export_man]: Export a foreign configuration to standard output. |
| 10 | 10 |
* [`derivepassphrase-export-vault(1)`][export_man]: Export a vault-native configuration to standard output. |
| 11 | 11 |
|
| 12 |
-## Modules and packages |
|
| 12 |
+## Modules and packages (API docs) |
|
| 13 | 13 |
|
| 14 | 14 |
* `derivepassphrase`: Work-alike for vault(1) – deterministic, stateless password manager. |
| 15 | 15 |
* [`derivepassphrase.cli`][]: Command-line interface for `derivepassphrase`. |
| ... | ... |
@@ -21,7 +21,13 @@ title: Reference overview |
| 21 | 21 |
* [`derivepassphrase._types`][]: Types used by `derivepassphrase`. |
| 22 | 22 |
* [`derivepassphrase.vault`][]: Python port of the vault(1) password generation scheme. |
| 23 | 23 |
|
| 24 |
+## Technical prerequisites |
|
| 25 |
+ |
|
| 26 |
+* Prerequisites for [using `derivepassphrase vault` with an SSH key][PREREQ_SSH_KEY] |
|
| 27 |
+ |
|
| 24 | 28 |
[top_man]: derivepassphrase.1.md |
| 25 | 29 |
[vault_man]: derivepassphrase-vault.1.md |
| 26 | 30 |
[export_man]: derivepassphrase-export.1.md |
| 27 | 31 |
[export_vault_man]: derivepassphrase-export-vault.1.md |
| 32 |
+ |
|
| 33 |
+ [PREREQ_SSH_KEY]: prerequisites-ssh-key.md |
| ... | ... |
@@ -89,23 +89,26 @@ plugins: |
| 89 | 89 |
nav: |
| 90 | 90 |
- Overview: index.md |
| 91 | 91 |
- Tutorials & Examples: |
| 92 |
+ - tutorials/index.md |
|
| 92 | 93 |
- tutorials/basic-setup-passphrase.md |
| 93 | 94 |
- How-Tos: |
| 95 |
+ - how-tos/index.md |
|
| 94 | 96 |
- how-tos/ssh-key.md |
| 95 | 97 |
- Reference: |
| 96 | 98 |
- reference/index.md |
| 97 |
- - 'Man page: derivepassphrase': reference/derivepassphrase.1.md |
|
| 98 |
- - 'Man page: derivepassphrase-vault': reference/derivepassphrase-vault.1.md |
|
| 99 |
- - 'Man page: derivepassphrase-export': reference/derivepassphrase-export.1.md |
|
| 100 |
- - 'Man page: derivepassphrase-export-vault': reference/derivepassphrase-export-vault.1.md |
|
| 101 |
- - Module derivepassphrase: |
|
| 99 |
+ - Man pages: |
|
| 100 |
+ - 'derivepassphrase(1)': reference/derivepassphrase.1.md |
|
| 101 |
+ - 'derivepassphrase-vault(1)': reference/derivepassphrase-vault.1.md |
|
| 102 |
+ - 'derivepassphrase-export(1)': reference/derivepassphrase-export.1.md |
|
| 103 |
+ - 'derivepassphrase-export-vault(1)': reference/derivepassphrase-export-vault.1.md |
|
| 104 |
+ - 'API docs: Module derivepassphrase': |
|
| 102 | 105 |
- Submodule cli: reference/derivepassphrase.cli.md |
| 103 | 106 |
- Subpackage exporter: reference/derivepassphrase.exporter.md |
| 104 | 107 |
- Submodule sequin: reference/derivepassphrase.sequin.md |
| 105 | 108 |
- Submodule ssh_agent: reference/derivepassphrase.ssh_agent.md |
| 106 | 109 |
- Submodule _types: reference/derivepassphrase._types.md |
| 107 | 110 |
- Submodule vault: reference/derivepassphrase.vault.md |
| 108 |
- - Prerequisites: |
|
| 111 |
+ - Technical prerequisites: |
|
| 109 | 112 |
- 'Using derivepassphrase vault with an SSH key': reference/prerequisites-ssh-key.md |
| 110 | 113 |
#- Design & Background: explanation.md |
| 111 | 114 |
- Changelog: changelog.md |
| 112 | 115 |