Skip to content

Commit f6c6f5b

Browse files
dfa1claude
andcommitted
docs: mention Diátaxis in README; drop completed TODO item
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent dc86280 commit f6c6f5b

2 files changed

Lines changed: 2 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,8 @@ java -jar cli/target/vortex.jar <subcommand> [args]
115115

116116
## Documentation
117117

118+
Docs follow the [Diátaxis](https://diataxis.fr/) framework (tutorial, how-to, reference, explanation).
119+
118120
| Document | Contents |
119121
|---|---|
120122
| [docs/tutorial.md](docs/tutorial.md) | Step-by-step: write and read your first Vortex file |

TODO.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@
5353

5454
## Documentation
5555

56-
- [ ] Use Diátaxis (https://diataxis.fr/) to structure docs: tutorials, how-to guides, reference, explanation
5756
- [ ] Format specification: byte-exact diagrams for file layout and each encoding, with annotated examples (Arrow spec style)
5857
- [ ] how to use the library and the cli
5958

0 commit comments

Comments
 (0)