Skip to content

docs: add Diátaxis documentation types to README standards #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joshschmelzle merged 2 commits into from
Sep 29, 2026
Merged

docs: add Diátaxis documentation types to README standards #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
625c8c8
docs: add Diátaxis documentation types to README standards
joshschmelzle Sep 29, 2026
96eb462
docs: place working notes and troubleshooting in the docs layout
joshschmelzle Sep 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions REPOS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,5 +86,9 @@ issues are tracked against each repository.
`wlanpi-fpms`, `wlanpi-hwtest`, `wlanpi-profiler`, and `wlanpi-webui` have
any.
- README link back to this repo: only `wlanpi-common` and `wlanpi-desktop`.
- `docs/` layout ([Documentation Types](style/README_STANDARDS.md#documentation-types)):
no repo uses the four type folders yet. `wlanpi-app`, `wlanpi-core`,
`wlanpi-mcp`, `wlanpi-misc-firmware`, `wlanpi-profiler`, and
`pi-gen-bookworm` have flat or ad-hoc `docs/` folders.
- BSD-3-Clause migration: `wlanpi-bridge`, `wlanpi-chat-bot` (archived),
`wlanpi-kernel`, `wlanpi-misc-packages`, and `wlanpi-wconsole` are MIT.
27 changes: 26 additions & 1 deletion style/README_STANDARDS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,32 @@ Sections should appear in this order where applicable:
11. Authors
12. License

Deep debugging notes, workarounds, and edge-case instructions belong in a separate `TROUBLESHOOTING.md`, not the main README.
Deep debugging notes, workarounds, and edge-case instructions belong in a how-to page, not the main README: `TROUBLESHOOTING.md`, or `docs/how-to/troubleshooting.md` once the repo has a `docs/` folder.

## Documentation Types

Classify every page by the reader's need, following [Diátaxis](https://diataxis.fr/). A page serves one need. Content for another need goes on its own page, linked.

| Type | Reader need | Page content | Example |
|------|-------------|--------------|---------|
| Tutorial | Learn | One guided, end-to-end path that works for a newcomer | Build your first package |
| How-to | Get a task done | Imperative steps; assumes basic competence | Configure a reverse proxy |
| Reference | Look up a fact | Complete, accurate facts: options, defaults, endpoints, config keys. No steps, no rationale | CLI flags |
| Explanation | Understand why | Context, design rationale, trade-offs. No steps | Why services run under systemd |

A README is the entry point: What / Why, short install and usage, links. When a repo's docs outgrow it, add a `docs/` folder with only the subfolders that have pages:

```text
docs/
tutorials/
how-to/
reference/
explanation/
```

Plans, PRDs, specs, and handover notes are working documents, not reader docs. Keep them outside the four type folders (for example `docs/plans/`).

Fix a page's type when you touch it for another reason. Do not rewrite docs in bulk.

## Headings

Expand Down