Format Markdown with prettier and move documents out of the root, as REPO_POLICIES.md requires #411

Closed
opened 2026-11-10 20:49:43 +01:00 by clawbot · 1 comment
Collaborator

vaultik misses two rules of its own REPO_POLICIES.md:

  • Markdown is not formatted. The policy names prettier as the Markdown formatter, with 4-space indents and proseWrap: always. script/fmt and script/fmt-check run only gofmt. The reviews of #399 note that its documents were wrapped by hand for this reason.
  • The root holds documents. The policy keeps the root to project-level files, with documentation under docs/ and configuration examples under configs/. ARCHITECTURE.md, TODO.md and config.example.yml are in the root.

Read first, in full: REPO_POLICIES.md in this repo, and https://git.eeqj.de/sneak/prompts/src/branch/main/prompts/CODE_STYLEGUIDE.md for the shell scripts.

Definition of done

  • script/fmt formats Go as it does now and all Markdown with prettier. script/fmt-check checks both and fails on either. Copy the Markdown part from sneak/prompts (script/fmt, script/fmt-check, the node and yarn steps of script/bootstrap, .prettierrc, .prettierignore, package.json, yarn.lock), with the same pinned versions. node_modules/ is in .gitignore and .dockerignore.
  • script/cibuild still passes on a fresh clone of a host with only docker and git, as the policy requires.
  • git mv moves ARCHITECTURE.md and TODO.md into docs/, and config.example.yml into configs/. Every reference to the old paths is fixed: README links, other documents, Go tests and error messages, script/, the CI workflow, .goreleaser.yaml, the Dockerfile and .dockerignore. Search the whole tree for each old path. Leave the history entries in TODO.md alone.
  • Commits, each pushed when made: the formatter setup; one commit that only runs make fmt over the Markdown; the moves with the reference fixes. No text change beyond what prettier writes.
  • make check passes.

Open PRs. #399, #404 and #405 edit the same documents. Do not touch them. Each is rebased onto next after this merges.

Model: opus-5-5

vaultik misses two rules of its own `REPO_POLICIES.md`: - **Markdown is not formatted.** The policy names `prettier` as the Markdown formatter, with 4-space indents and `proseWrap: always`. `script/fmt` and `script/fmt-check` run only `gofmt`. The reviews of https://git.eeqj.de/sneak/vaultik/pulls/399 note that its documents were wrapped by hand for this reason. - **The root holds documents.** The policy keeps the root to project-level files, with documentation under `docs/` and configuration examples under `configs/`. `ARCHITECTURE.md`, `TODO.md` and `config.example.yml` are in the root. **Read first, in full:** `REPO_POLICIES.md` in this repo, and https://git.eeqj.de/sneak/prompts/src/branch/main/prompts/CODE_STYLEGUIDE.md for the shell scripts. **Definition of done** - `script/fmt` formats Go as it does now and all Markdown with `prettier`. `script/fmt-check` checks both and fails on either. Copy the Markdown part from `sneak/prompts` (`script/fmt`, `script/fmt-check`, the node and yarn steps of `script/bootstrap`, `.prettierrc`, `.prettierignore`, `package.json`, `yarn.lock`), with the same pinned versions. `node_modules/` is in `.gitignore` and `.dockerignore`. - `script/cibuild` still passes on a fresh clone of a host with only docker and git, as the policy requires. - `git mv` moves `ARCHITECTURE.md` and `TODO.md` into `docs/`, and `config.example.yml` into `configs/`. Every reference to the old paths is fixed: README links, other documents, Go tests and error messages, `script/`, the CI workflow, `.goreleaser.yaml`, the `Dockerfile` and `.dockerignore`. Search the whole tree for each old path. Leave the history entries in `TODO.md` alone. - Commits, each pushed when made: the formatter setup; one commit that only runs `make fmt` over the Markdown; the moves with the reference fixes. No text change beyond what `prettier` writes. - `make check` passes. **Open PRs.** 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 edit the same documents. Do not touch them. Each is rebased onto `next` after this merges. Model: opus-5-5
clawbot self-assigned this 2026-11-10 20:49:43 +01:00
Author
Collaborator

PR: #415

  • script/fmt and script/fmt-check now run prettier over all Markdown after the Go step, with the files and pins copied from sneak/prompts.
  • One commit only runs make fmt over the Markdown.
  • docs/ARCHITECTURE.md, docs/TODO.md and configs/config.example.yml are moved with git mv, and every reference follows them.
  • Deviation: script/bootstrap also installs curl when missing. Without it, script/install-go stopped a host with only docker and git, before this change too.

Model: opus-5-5

PR: https://git.eeqj.de/sneak/vaultik/pulls/415 - `script/fmt` and `script/fmt-check` now run `prettier` over all Markdown after the Go step, with the files and pins copied from `sneak/prompts`. - One commit only runs `make fmt` over the Markdown. - `docs/ARCHITECTURE.md`, `docs/TODO.md` and `configs/config.example.yml` are moved with `git mv`, and every reference follows them. - Deviation: `script/bootstrap` also installs `curl` when missing. Without it, `script/install-go` stopped a host with only docker and git, before this change too. Model: opus-5-5
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/vaultik#411