dataverket/fabrikk
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Activity Actions

docs: the fabrikk manual, Diátaxis with a page schema, and the program/skills/docs split #7

Merged
beddari merged 1 commit from docs-manual into main 2026-09-17 17:25:23 +00:00
Conversation 0 Commits 1 Files changed 17 +1316 -130
beddari commented 2026-09-17 17:22:56 +00:00
Owner
Copy link

The manual for the machine under docs/: explanation (how fabrikk works, attestation and trust, release model; six Mermaid diagrams), reference (code map, factory definition, swamp CLI), guides (workstation, drive a work item, operate the forge, reference repositories), tutorials and decisions placeholders.

  • docs/README.md: the program / skills / docs split from the software-factory talk, one tree merged by metadata, the page schema (type, project, audience, last-verified, context), and the bounding rules with a proposed docs-check.
  • CLAUDE.md points agents at the manual. The README is the front door and status board and links to docs/.
  • ADRs move from docs/adr/ to docs/decisions/ in the source-standards skill and the attest workflow (protected paths).
  • Protected paths changed: CLAUDE.md, skills/, workflows/. Human review required; no attestation tag, so validate-attestation fails by design.
The manual for the machine under `docs/`: explanation (how fabrikk works, attestation and trust, release model; six Mermaid diagrams), reference (code map, factory definition, swamp CLI), guides (workstation, drive a work item, operate the forge, reference repositories), tutorials and decisions placeholders. - `docs/README.md`: the program / skills / docs split from the software-factory talk, one tree merged by metadata, the page schema (`type`, `project`, `audience`, `last-verified`, `context`), and the bounding rules with a proposed `docs-check`. - `CLAUDE.md` points agents at the manual. The README is the front door and status board and links to `docs/`. - ADRs move from `docs/adr/` to `docs/decisions/` in the source-standards skill and the attest workflow (protected paths). - Protected paths changed: `CLAUDE.md`, `skills/`, `workflows/`. Human review required; no attestation tag, so `validate-attestation` fails by design.
docs: the fabrikk manual, Diátaxis with a page schema, and the program/skills/docs split
Some checks failed
validate-attestation / validate (pull_request) Failing after 2m46s
Details
fc9fc8bb9c
 
docs/ is the manual for the machine: explanation (how fabrikk works, attestation and trust, the release model, with
Mermaid diagrams), reference (code map, factory definition contract, swamp CLI), guides (workstation, drive a work
item, operate the forge, reference repositories), and placeholders for tutorials and decisions. One tree, Diátaxis
first; what a page is about is frontmatter (type, project, audience, last-verified, context), the way the Dataverket
docs site already groups ADRs by metadata. A product's design is the explanation pages that name it; swamp's
admission rule and last-verified become schema requirements, and the bounding rules name a docs-check to build.

docs/README.md states the three-way split from the software-factory talk: the program makes things happen and is
where trust comes from, skills are context, docs explain. CLAUDE.md points agents at the manual. The README is now
the front door and status board and links here. ADRs move from docs/adr/ to docs/decisions/ in the source-standards
skill and the attest workflow's protected paths, matching the docs site.
beddari deleted branch docs-manual 2026-09-17 17:25:23 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
dataverket/fabrikk!7
No description provided.