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.
50 lines
2.5 KiB
Markdown
50 lines
2.5 KiB
Markdown
|
|
|
|
# ~/workspace
|
|
|
|
A private, terminal-themed workspace that runs in the browser: a diary, the
|
|
notes for work and for uni, a board per space, and the files that go with them.
|
|
One user, one SQLite file, one binary. Everything is a key or a `:` command on
|
|
the desktop, and a button on the phone.
|
|
|
|
|
|
|
|
## Where to start
|
|
|
|
- **[Getting started](Getting-Started.md)**: run it, log in, find your way
|
|
around in the first ten minutes.
|
|
- **[The guide](Guide.md)**: a day with the workspace, from the morning's
|
|
agenda to the evening's diary entry, with every part explained on the way.
|
|
- **[Keys and commands](Commands.md)**: the full list, the same one `?` shows.
|
|
|
|
## The parts
|
|
|
|
| page | what it covers |
|
|
| --- | --- |
|
|
| [Spaces and documents](Spaces-and-Documents.md) | spaces, folders, the list, tiles, moving things |
|
|
| [Writing](Writing.md) | the editor, vim, markdown, math, links between documents, templates |
|
|
| [Boards and the agenda](Boards-and-Agenda.md) | cards, due dates, cards that come back, the agenda |
|
|
| [The diary](Diary.md) | entries, today, the calendar, on this day |
|
|
| [Files and search](Files-and-Search.md) | uploads, what opens in place, full-text search |
|
|
| [Not losing things](Not-Losing-Things.md) | autosave, history, the trash, export and import |
|
|
| [The vault](Vault.md) | files sealed under a password of their own |
|
|
| [Capture](Capture.md) | writing things down from a phone or a script |
|
|
| [Sharing](Sharing.md) | read-only links to one document |
|
|
| [The SFTP mount](SFTP.md) | the workspace as a filesystem |
|
|
| [Backup and mail](Backup-and-Mail.md) | Proton Drive mirror, reminders and digests |
|
|
| [Deploying](Deploying.md) | running it on a server, behind a proxy, in Docker |
|
|
| [Configuration](Configuration.md) | every setting |
|
|
| [API](API.md) | every route |
|
|
| [Development](Development.md) | the code, the checks, the screenshots and this wiki |
|
|
|
|
## Screens
|
|
|
|
| | |
|
|
| --- | --- |
|
|
|  |  |
|
|
| Two documents side by side, each in a tile of its own. | A board: the first list is the inbox, the last is done. |
|
|
|  |  |
|
|
| The agenda: what is late, due, or in hand, on every board. | The diary by month. |
|
|
|  |  |
|
|
| A search finds the text inside files too. | Certificates and keys are read on the server. |
|