mirror of
https://github.com/narrrl/narl-workspace.git
synced 2026-11-04 00:47:01 +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.
38 lines
913 B
Makefile
38 lines
913 B
Makefile
.PHONY: dev dev-api dev-web build run check wiki screenshots clean
|
|
|
|
# Two terminals: `make dev-api` and `make dev-web` (http://127.0.0.1:4243).
|
|
dev-api:
|
|
cargo run
|
|
|
|
dev-web:
|
|
cd web && bun run dev
|
|
|
|
# Everything, as one self-contained release binary at target/release/narl-workspace.
|
|
build:
|
|
cd web && bun install --frozen-lockfile && bun run build
|
|
cargo build --release
|
|
|
|
run: build
|
|
./target/release/narl-workspace
|
|
|
|
check:
|
|
cargo fmt --check
|
|
cargo clippy --all-targets -- -D warnings
|
|
cargo test
|
|
cd web && bun run check
|
|
bun scripts/wiki.ts --check
|
|
|
|
# The generated wiki pages, from the code they describe: see docs/wiki/Development.md.
|
|
wiki:
|
|
bun scripts/wiki.ts
|
|
|
|
# docs/images, taken again from a throwaway workspace in a headless Chromium.
|
|
screenshots:
|
|
cd web && bun install --frozen-lockfile && bun run build
|
|
cargo build
|
|
bun scripts/screenshots.ts
|
|
|
|
clean:
|
|
cargo clean
|
|
rm -rf web/dist web/node_modules
|