eho/register-referentie
1
0
Fork 0
Code Issues 17 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

S-00-e · Docs scaffold: MkDocs + ADR-0001 + README quickstart #32

New Issue
Closed
opened 2026-06-03 11:28:56 +00:00 by eho · 0 comments
eho commented 2026-06-03 11:28:56 +00:00
Owner
Copy Link

Outcome: MkDocs Material builds the docs/ site; docs/architecture/adr-0001-loose-coupling.md exists as the ADR template; README gains a sub-10-minute quickstart.

Acceptance:

  • mkdocs build succeeds (mkdocs.yml + nav).
  • adr-0001-loose-coupling.md present, Nygard template.
  • A new developer following README.md reaches a green local environment in under 10 minutes.

Touches: mkdocs.yml, docs/ nav, docs/architecture/adr-0001-loose-coupling.md, README.md.

Out of scope: Gitea Pages publish workflow (later).

Definition of Done

  • A linked Gitea issue exists (this one).
  • Failing test written and committed first.
  • Implementation makes the test pass.
  • Refactor commit follows if structure improved.
  • Conventional Commit messages referencing this issue (refs #NN).
  • All Gitea Actions CI jobs green.
  • docker compose up from a fresh clone reaches green health checks within 3 minutes.
  • Docs touched if behaviour, contracts, or operations changed.
  • ADR added in docs/architecture/ if a non-obvious decision was made.
  • This issue closed by the merging PR (closes #NN).

Split from #1 (S-00) per CLAUDE.md §13.

**Outcome:** MkDocs Material builds the `docs/` site; `docs/architecture/adr-0001-loose-coupling.md` exists as the ADR template; README gains a sub-10-minute quickstart. **Acceptance:** - `mkdocs build` succeeds (`mkdocs.yml` + nav). - `adr-0001-loose-coupling.md` present, Nygard template. - A new developer following `README.md` reaches a green local environment in under 10 minutes. **Touches:** `mkdocs.yml`, `docs/` nav, `docs/architecture/adr-0001-loose-coupling.md`, `README.md`. **Out of scope:** Gitea Pages publish workflow (later). ## Definition of Done - [ ] A linked Gitea issue exists (this one). - [ ] Failing test written and committed first. - [ ] Implementation makes the test pass. - [ ] Refactor commit follows if structure improved. - [ ] Conventional Commit messages referencing this issue (`refs #NN`). - [ ] All Gitea Actions CI jobs green. - [ ] `docker compose up` from a fresh clone reaches green health checks within 3 minutes. - [ ] Docs touched if behaviour, contracts, or operations changed. - [ ] ADR added in `docs/architecture/` if a non-obvious decision was made. - [ ] This issue closed by the merging PR (`closes #NN`). _Split from #1 (S-00) per CLAUDE.md §13._
eho added this to the Iteration 0 — Foundations milestone 2026-06-03 11:28:56 +00:00
eho added the type:slicearea:docs labels 2026-06-03 11:28:56 +00:00
eho closed this issue 2026-06-03 12:13:33 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
area:acl
area:bff
area:docs
area:domain
area:event-subscriber
area:infra
area:portal-behandel
area:portal-beheer
area:portal-openbaar
area:portal-self-service
area:projection
area:workflow
type:adr-proposal
type:bug
type:chore
type:slice
No Label area:docs type:slice
Milestone
No items
No Milestone Iteration 0 — Foundations
Projects
Clear projects
No project
Assignees
Clear assignees
eho
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: eho/register-referentie#32
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?