@romansmirnov/doku 1.0.4 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -19,6 +19,17 @@ A personal documentation system that stores docs as plain Markdown files and pro
|
|
|
19
19
|
- **Breadcrumb navigation** — clickable path segments to navigate parent pages
|
|
20
20
|
- **No database** — the filesystem is the single source of truth
|
|
21
21
|
|
|
22
|
+
## AI-Friendly
|
|
23
|
+
|
|
24
|
+
Doku is designed to work well with AI agents and coding assistants:
|
|
25
|
+
|
|
26
|
+
- **Plain Markdown** — all docs are standard `.md` files that AI agents can read and write directly
|
|
27
|
+
- **CLAUDE.md** — project conventions and rules for AI assistants working on the codebase
|
|
28
|
+
- **AGENTS.md** — detailed instructions for AI agents creating, editing, and organizing documentation files (frontmatter rules, folder conventions, ordering guidelines)
|
|
29
|
+
- **Simple file structure** — no database, no binary formats, no proprietary storage. Just files and folders that any tool can work with
|
|
30
|
+
- **CLI init** — agents can scaffold new doc projects with `npx @romansmirnov/doku init ./path`
|
|
31
|
+
- **REST API** — all operations available via HTTP endpoints for programmatic access
|
|
32
|
+
|
|
22
33
|
## Quick Start
|
|
23
34
|
|
|
24
35
|
```bash
|