mirror of
https://github.com/narrrl/narl-workspace.git
synced 2026-11-03 16:41:27 +01:00
nvrl
c70bfdd7be
The guide opens with documents, cards, notes and diary entries, and the documents and plan screens, then walks the day with the scratchpad, the info sheet and cards linked both ways. The README and the wiki's home say the same in short, and show the scratchpad and the info sheet. The screenshot script drops its Alt keys and takes both. PLAN.md records the simplification's slices, what was left of its navigation fixes, and the backlog fitted to the model.
57 lines
3.1 KiB
Markdown
57 lines
3.1 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.
|
|
|
|
It keeps four things: **documents**, the thorough record; **cards**, the short
|
|
summary of work, usually about a document; **notes**, jotted in passing on the
|
|
scratchpad until they become one of the others; and **diary entries**. The
|
|
[guide](Guide.md#four-things-two-screens) says how they fit together.
|
|
|
|
|
|
|
|
## 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, the scratchpad, markdown, math, links between documents, templates |
|
|
| [Boards and the agenda](Boards-and-Agenda.md) | cards, due dates, cards that come back, the plan screen, 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. |
|
|
|  |  |
|
|
| The scratchpad, lowered over the documents. | The cards about a document, in its info sheet. |
|