docs: refresh CI + lint/format docs (Phase 8 + Phase 13) #9

Merged
luckberg merged 3 commits from gsd/docs-ci-lint-refresh into main 2026-06-12 08:54:18 -04:00
Owner

Refreshes the five docs whose content changed with Phase 8 (Gitea CI) and Phase 13 (real lint/format gate). Each was rewritten by exploring the live codebase, then Prettier-formatted so it passes the new format gate.

Updated

  • README.mdformat/format:check/test:e2e added to the commands table; new CI section documenting the 3 required PR checks (fast-checks, api, harness).
  • docs/CONFIGURATION.md — lint/format config files (eslint.config.js, .prettierrc, .prettierignore); new CI Secrets section documenting REGISTRY_PAT (the GITEA_ prefix is reserved).
  • docs/DEVELOPMENT.md — real pnpm lint/format/format:check/typecheck dev commands + 'run before pushing, CI gates on them'.
  • docs/TESTING.md — lint+format gates folded into the quality story; the 3 CI jobs documented; API integration tests' MariaDB requirement.
  • docs/deployment.md — CI gate on PRs + publish.yml image build/push on merge (registry, tag scheme, REGISTRY_PAT + --password-stdin). 4 <!-- VERIFY --> markers on infra claims not derivable from the repo (Unraid/registry-host specifics — please eyeball).

Notes

  • Verified locally: pnpm format:check = 0, pnpm lint = 0. Fact-checked every referenced command against package.json and CI job names against ci.yml.
  • Doc-only change, but branch protection still runs the full CI (incl. the slow harness) before merge.
Refreshes the five docs whose content changed with Phase 8 (Gitea CI) and Phase 13 (real lint/format gate). Each was rewritten by exploring the live codebase, then Prettier-formatted so it passes the new format gate. ## Updated - **README.md** — `format`/`format:check`/`test:e2e` added to the commands table; new CI section documenting the 3 required PR checks (`fast-checks`, `api`, `harness`). - **docs/CONFIGURATION.md** — lint/format config files (`eslint.config.js`, `.prettierrc`, `.prettierignore`); new CI Secrets section documenting `REGISTRY_PAT` (the `GITEA_` prefix is reserved). - **docs/DEVELOPMENT.md** — real `pnpm lint`/`format`/`format:check`/`typecheck` dev commands + 'run before pushing, CI gates on them'. - **docs/TESTING.md** — lint+format gates folded into the quality story; the 3 CI jobs documented; API integration tests' MariaDB requirement. - **docs/deployment.md** — CI gate on PRs + `publish.yml` image build/push on merge (registry, tag scheme, `REGISTRY_PAT` + `--password-stdin`). 4 `<!-- VERIFY -->` markers on infra claims not derivable from the repo (Unraid/registry-host specifics — please eyeball). ## Notes - Verified locally: `pnpm format:check` = 0, `pnpm lint` = 0. Fact-checked every referenced command against package.json and CI job names against ci.yml. - Doc-only change, but branch protection still runs the full CI (incl. the slow harness) before merge.
luckberg added 1 commit 2026-06-11 22:21:38 -04:00
docs: refresh CI + lint/format docs (Phase 8 + Phase 13)
CI / fast-checks (pull_request) Successful in 1m23s
CI / api (pull_request) Successful in 1m0s
CI / harness (pull_request) Successful in 3m27s
213aeba347
luckberg added 1 commit 2026-06-11 22:25:32 -04:00
docs(graph): refresh knowledge-graph artifacts (rebuilt at 63ae0c6 — 5924 nodes/6053 edges)
CI / fast-checks (pull_request) Successful in 1m22s
CI / api (pull_request) Successful in 1m0s
CI / harness (pull_request) Successful in 3m29s
cfb2fd3cf9
luckberg added 1 commit 2026-06-11 22:29:39 -04:00
docs: add backlog 999.17 (CI doc-only PR skip) + remove stale graph.html
CI / fast-checks (pull_request) Successful in 1m19s
CI / api (pull_request) Successful in 58s
CI / harness (pull_request) Successful in 3m16s
5ab463ccbb
luckberg merged commit 75760e9d7d into main 2026-06-12 08:54:18 -04:00
luckberg deleted branch gsd/docs-ci-lint-refresh 2026-06-12 08:54:19 -04:00
Sign in to join this conversation.
No Reviewers
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: luckberg/familysync#9