From fb8f98a47d1705b153d82f520d663b79bf65c88b Mon Sep 17 00:00:00 2001 From: Erich Blume Date: Tue, 3 Feb 2026 08:02:36 -0800 Subject: [PATCH] Update main README to reflect docs restructuring Point to docs/README.md for the restructuring plan and clarify that zk cards now live in docs/zk/. Co-Authored-By: Claude Opus 4.5 --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 370bb0e..c41fc18 100644 --- a/README.md +++ b/README.md @@ -80,10 +80,11 @@ This repo uses [Forgejo Actions](https://forgejo.org/docs/latest/user/actions/) ## Documentation -Documentation lives in `docs/` and covers infrastructure, services, and operational runbooks. View all docs with: +Documentation lives in `docs/` and is being restructured to follow the [Diataxis](https://diataxis.fr/) framework. See [`docs/README.md`](docs/README.md) for the restructuring plan and current status. +**Quick reference (zettelkasten cards):** ```bash mise run zk-docs ``` -The docs use [Obsidian](https://obsidian.md) wiki-link syntax (`[[link]]`) for cross-references. Edit with any markdown editor, or use [obsidian.nvim](https://github.com/obsidian-nvim/obsidian.nvim) for enhanced navigation and completion. +The zk cards in `docs/zk/` use [Obsidian](https://obsidian.md) wiki-link syntax (`[[link]]`) for cross-references. Edit with any markdown editor, or use [obsidian.nvim](https://github.com/obsidian-nvim/obsidian.nvim) for enhanced navigation and completion.