Essential session storage is required to sign in. Optional analytics remain off unless you allow them.
Document a small tool or API by producing a proper doc SET organized with Diataxis: at least one TUTORIAL (a guaranteed-success learning path for a newcomer), one HOW-TO guide (steps to solve a specific task), and one REFERENCE page (complete, consistent, lookup-oriented) — and keep the types distinct (don't turn the tutorial into reference). Author it docs-as-code: Markdown in a Git repo, built with a static site generator (Docusaurus/MkDocs), with sensible information architecture (navigation, headings, cross-links). Apply a style guide (e.g. Google's) consistently.
Tutorial, how-to, and reference are present and correctly distinct (tutorial teaches a newcomer; how-to solves a task; reference is lookup) — not blended.
Markdown in Git, built with a static site generator; navigable IA; could be reviewed via PRs.
Clear writing; a style guide applied consistently; terminology consistent; instructions actionable.
A reader could actually accomplish the tutorial's goal and look up reference facts.
Use this README structure to make the work reviewable.
DevPath fetches a read-only, size-capped snapshot. Submitted code is never executed.
# A Diataxis-structured doc set in docs-as-code ## Goal Document a small tool or API by producing a proper doc SET organized with Diataxis: at least one TUTORIAL (a guaranteed-success learning path for a newcomer), one HOW-TO guide (steps to solve a specific task), and one REFERENCE page (complete, consistent, lookup-oriented) — and keep the types distinct (don't turn the tutorial into reference). Author it docs-as-code: Markdown in a Git repo, built with a static site generator (Docusaurus/MkDocs), with sensible information architecture (navigation, headings, cross-links). Apply a style guide (e.g. Google's) consistently. ## Acceptance criteria - [ ] Diataxis correctness: Tutorial, how-to, and reference are present and correctly distinct (tutorial teaches a newcomer; how-to solves a task; reference is lookup) — not blended. - [ ] Docs-as-code: Markdown in Git, built with a static site generator; navigable IA; could be reviewed via PRs. - [ ] Clarity & consistency: Clear writing; a style guide applied consistently; terminology consistent; instructions actionable. - [ ] Completeness: A reader could actually accomplish the tutorial's goal and look up reference facts. ## Verification - [ ] Document installation and run commands. - [ ] Record automated checks and their exact commands. - [ ] Add representative output, screenshots, or a short demo where useful. - [ ] Confirm failure paths and known constraints. ## Decision log ### Decision title - Context: - Choice: - Alternatives considered: - Tradeoffs: ## Evidence - Link each rubric criterion to the file, test, or artifact that demonstrates it. ## Known limitations - List what is intentionally out of scope and what should be improved next.