Make goal 12 great documentation, state how the README meets it, and plan the README's reorganisation for 0.2.0
Tests / vet + fmt + tests (pull_request) Has been cancelled
Tests / Known vulnerabilities in this Go version and the required modules (pull_request) Has been cancelled
Tests / Release from CHANGELOG.md (pull_request) Has been cancelled
Tests / packages (pull_request) Has been cancelled

This commit is contained in:
2026-10-14 22:50:30 +02:00
parent 5b1169f9a5
commit 79dafa38f0
2 changed files with 38 additions and 11 deletions
+16 -4
View File
@@ -1117,10 +1117,7 @@ Where the project is heading; the sections before Audience document what ships t
1. In the library, the caller supplies everything that can change the output: data,
seed and date.
11. **No unnecessary runtime dependencies** — use standard library by default.
12. **The docs are a map of the template language.**
1. Every feature has its own heading.
2. Every example runs as a test and shows its output.
3. Each rule is stated in one place.
12. **Great documentation.**
13. **It is fast enough that you never notice it with the shipped data.**
1. A render's cost grows only with the data it reaches.
14. **Strongly prioritize data sourced from good online sources**
@@ -1313,6 +1310,21 @@ replaces what it uploaded before. For a tag older than the latest release it lea
tap, the bucket, the image's `latest` tags and the repositories alone, since each holds one
version.
### Documentation
How the README serves goal 12:
- The top shows the CLI and the library side by side, each a short quickstart rendering
the same value.
- A table of the shipped data follows: every path, an example value, and what makes it
valid or where it comes from.
- Recipes show common tasks end to end.
- Every feature has its own heading, and the docs are a map of the template language.
- Every example runs as a test and shows its output.
- Each rule is stated in one place.
- Edge cases and a category's caveats sit in the reference sections, below what a first
reader needs.
## License
MIT — see [LICENSE](LICENSE). Forked from [github.com/Timewave-AB/fakes](https://github.com/Timewave-AB/fakes).