mirror of
https://github.com/narrrl/narl-workspace.git
synced 2026-11-03 16:41:27 +01:00
nvrl
4eb663e2d7
The README grew a section per feature and is a good reference, but nothing said where to begin. docs/wiki now has a getting-started page, a guide that walks through one day with the workspace and explains each part where it comes up, and a page per part of the app, each with screenshots of what it describes. Three pages are read out of the code rather than written, so they cannot drift from it: the keys and commands from Help.svelte and commands.ts, the same lists `:help` draws; the settings from .env.example, which gains a heading for the vault, trash and history settings so they no longer sit under mail; and the API from the README's table. `make wiki` writes them, and `--check` fails when one is stale or a link between pages leads nowhere. `--publish` lays the pages out for a GitHub wiki: links without `.md`, images beside them, `[[` escaped so the wiki does not take a command's help text for a link to a page. The screenshots are taken by `make screenshots`: the debug binary on a temporary data directory, with a password made up for the run, filled with an example workspace over the API, and a headless Chromium driven over the DevTools protocol through the views the docs show. Nothing outside the temporary directory is touched but docs/images, and the pictures are cut to 256 colours, a third of their size, which a dark UI does not show. The README opens with the banner, a CI badge, the guide, the features grouped by what they are for, and six of the screenshots.
30 lines
659 B
Markdown
30 lines
659 B
Markdown
**[~/workspace](Home.md)**
|
|
|
|
- [Getting started](Getting-Started.md)
|
|
- [The guide](Guide.md)
|
|
|
|
**Using it**
|
|
|
|
- [Spaces and documents](Spaces-and-Documents.md)
|
|
- [Writing](Writing.md)
|
|
- [Boards and the agenda](Boards-and-Agenda.md)
|
|
- [The diary](Diary.md)
|
|
- [Files and search](Files-and-Search.md)
|
|
- [Not losing things](Not-Losing-Things.md)
|
|
- [The vault](Vault.md)
|
|
- [Capture](Capture.md)
|
|
- [Sharing](Sharing.md)
|
|
- [The SFTP mount](SFTP.md)
|
|
- [Backup and mail](Backup-and-Mail.md)
|
|
|
|
**Reference**
|
|
|
|
- [Keys and commands](Commands.md)
|
|
- [Configuration](Configuration.md)
|
|
- [API](API.md)
|
|
|
|
**Running it**
|
|
|
|
- [Deploying](Deploying.md)
|
|
- [Development](Development.md)
|