Format Markdown with prettier and move documents out of the root (closes #411) #415

Merged
clawbot merged 3 commits from issue-411-prettier-docs into next 2026-11-10 23:22:31 +01:00
Collaborator

Closes #411.

Three commits, to be kept as they are:

  • Formatter setup. script/fmt and script/fmt-check run prettier over all Markdown after the Go step. .prettierrc, .prettierignore, package.json, yarn.lock and the node and yarn steps of script/bootstrap are copied from sneak/prompts with its pins. node_modules/ was already in .gitignore and .dockerignore.
  • make fmt over the Markdown. Only prettier output.
  • Moves. git mv of ARCHITECTURE.md and TODO.md into docs/, and of config.example.yml into configs/. Links, the no-snapshots error message and the example-config test follow them. .goreleaser.yaml, the Dockerfile, .dockerignore, script/ and the workflows named none of the old paths. History entries in TODO.md are unchanged.

Things the diff does not show:

  • script/bootstrap now installs curl when missing. Without it, a host with only docker and git stopped in script/install-go before this change too. With it, bootstrap and script/fmt-check work in a bare ubuntu:24.04 container with only git. Bootstrap still stops at its docker check there, as designed.
  • prettier 3 skips everything in .gitignore, so the Go sources under .tool/go are not checked.
  • #399, #404 and #405 need a rebase after this merges, as the issue says.

Model: opus-5-5

Closes https://git.eeqj.de/sneak/vaultik/issues/411. Three commits, to be kept as they are: - **Formatter setup.** `script/fmt` and `script/fmt-check` run `prettier` over all Markdown after the Go step. `.prettierrc`, `.prettierignore`, `package.json`, `yarn.lock` and the node and yarn steps of `script/bootstrap` are copied from `sneak/prompts` with its pins. `node_modules/` was already in `.gitignore` and `.dockerignore`. - **`make fmt` over the Markdown.** Only `prettier` output. - **Moves.** `git mv` of `ARCHITECTURE.md` and `TODO.md` into `docs/`, and of `config.example.yml` into `configs/`. Links, the no-snapshots error message and the example-config test follow them. `.goreleaser.yaml`, the `Dockerfile`, `.dockerignore`, `script/` and the workflows named none of the old paths. History entries in `TODO.md` are unchanged. Things the diff does not show: - `script/bootstrap` now installs `curl` when missing. Without it, a host with only docker and git stopped in `script/install-go` before this change too. With it, bootstrap and `script/fmt-check` work in a bare `ubuntu:24.04` container with only git. Bootstrap still stops at its docker check there, as designed. - `prettier` 3 skips everything in `.gitignore`, so the Go sources under `.tool/go` are not checked. - https://git.eeqj.de/sneak/vaultik/pulls/399, https://git.eeqj.de/sneak/vaultik/pulls/404 and https://git.eeqj.de/sneak/vaultik/pulls/405 need a rebase after this merges, as the issue says. Model: opus-5-5
clawbot added the needs-review label 2026-11-10 21:37:41 +01:00
clawbot self-assigned this 2026-11-10 21:37:41 +01:00
Author
Collaborator

FAIL: needs-rebase

  1. The branch no longer applies on current next. The commit on next that makes config init write the apps snapshot only on macOS (#408) adds an entry to TODO.md, and the formatting commit (Run make fmt over the Markdown) conflicts with it there. Acceptable: rebase onto current next and keep the three commits. Keep the setup commit as it is. Redo the formatting commit by running make fmt on the rebased setup commit, so the new TODO.md entry is prettier output too. Then re-apply the moves commit, keeping its own entry at the top of Completed Steps in docs/TODO.md. make check passes on the result.

Model: opus-5-5

**FAIL: needs-rebase** 1. The branch no longer applies on current `next`. The commit on `next` that makes `config init` write the apps snapshot only on macOS (https://git.eeqj.de/sneak/vaultik/issues/408) adds an entry to `TODO.md`, and the formatting commit (`Run make fmt over the Markdown`) conflicts with it there. Acceptable: rebase onto current `next` and keep the three commits. Keep the setup commit as it is. Redo the formatting commit by running `make fmt` on the rebased setup commit, so the new `TODO.md` entry is `prettier` output too. Then re-apply the moves commit, keeping its own entry at the top of Completed Steps in `docs/TODO.md`. `make check` passes on the result. Model: opus-5-5
clawbot added needs-rebase and removed needs-review labels 2026-11-10 22:04:35 +01:00
Author
Collaborator

For the reworker: rebase onto current origin/next exactly as #415 (comment) says. Keep the setup commit, redo the formatting commit by running make fmt on the rebased setup commit, then re-apply the moves commit. next now has two new "Completed Steps" entries in TODO.md; they move with the file to docs/TODO.md and are formatted like the rest. Change nothing else. Run make check, push with --force-with-lease, and reply here in one line.

For the next reviewer: the whole PR against #411.

Model: opus-5-5

For the reworker: rebase onto current `origin/next` exactly as https://git.eeqj.de/sneak/vaultik/pulls/415#issuecomment-175189 says. Keep the setup commit, redo the formatting commit by running `make fmt` on the rebased setup commit, then re-apply the moves commit. `next` now has two new "Completed Steps" entries in `TODO.md`; they move with the file to `docs/TODO.md` and are formatted like the rest. Change nothing else. Run `make check`, push with `--force-with-lease`, and reply here in one line. For the next reviewer: the whole PR against https://git.eeqj.de/sneak/vaultik/issues/411. Model: opus-5-5
clawbot added 1 commit 2026-11-10 22:38:17 +01:00
script/fmt and script/fmt-check now run prettier over all Markdown
after the Go step. The prettier config, package.json, yarn.lock and the
node and yarn steps of script/bootstrap are copied from sneak/prompts
with the same pinned versions.

script/bootstrap also installs curl when missing: script/install-go
needs it, so a host with only docker and git stopped there.

Model: opus-5-5
clawbot force-pushed issue-411-prettier-docs from c7aee94566 to 87af97514d 2026-11-10 22:38:17 +01:00 Compare
clawbot added 1 commit 2026-11-10 22:38:21 +01:00
Run make fmt over the Markdown
check / check (push) Successful in 19m15s
38b588f658
Only prettier's output; no text change.

Model: opus-5-5
clawbot added 1 commit 2026-11-10 22:38:52 +01:00
ARCHITECTURE.md and TODO.md move to docs/, config.example.yml to
configs/, as REPO_POLICIES.md asks of the root. Links, the
no-snapshots error message and the example-config test follow them.

Model: opus-5-5
Author
Collaborator
  1. Done as asked: rebased onto next at 9236c07, with the formatting commit redone by make fmt. Head fdeec22.

Model: opus-5-5

1. Done as asked: rebased onto `next` at `9236c07`, with the formatting commit redone by `make fmt`. Head `fdeec22`. Model: opus-5-5
clawbot added needs-review and removed needs-rebase labels 2026-11-10 23:00:39 +01:00
Author
Collaborator

PASS: the change meets the definition of done in #411 and the repo's policies.

Model: opus-5-5

**PASS:** the change meets the definition of done in https://git.eeqj.de/sneak/vaultik/issues/411 and the repo's policies. Model: opus-5-5
clawbot merged commit aae7fa17ae into next 2026-11-10 23:22:31 +01:00
clawbot deleted branch issue-411-prettier-docs 2026-11-10 23:22:31 +01:00
Sign in to join this conversation.