@infinitedusky/indusk-mcp 1.2.9 → 1.3.0
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/dist/bin/commands/init-docs.js +6 -0
- package/package.json +1 -1
- package/skills/document.md +25 -6
|
@@ -231,6 +231,12 @@ Architecture decision records for ${projectName}. Each decision documents what w
|
|
|
231
231
|
writeFileSync(join(docsDir, "src/lessons/index.md"), `# Lessons Learned
|
|
232
232
|
|
|
233
233
|
Insights from building ${projectName}. Each lesson captures what we learned, what surprised us, and what we'd do differently.
|
|
234
|
+
`);
|
|
235
|
+
writeFileSync(join(docsDir, "src/changelog.md"), `# Changelog
|
|
236
|
+
|
|
237
|
+
All notable changes to ${projectName} are documented here. Follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
|
238
|
+
|
|
239
|
+
## [Unreleased]
|
|
234
240
|
`);
|
|
235
241
|
// Dockerfile for local dev
|
|
236
242
|
const dockerDir = join(projectRoot, "docker");
|
package/package.json
CHANGED
package/skills/document.md
CHANGED
|
@@ -60,7 +60,8 @@ apps/indusk-docs/src/
|
|
|
60
60
|
│ ├── skills/ # One page per skill
|
|
61
61
|
│ └── tools/ # One page per tool (Biome, CGC, composable.env)
|
|
62
62
|
├── decisions/ # Distilled from ADRs during retrospective/archival
|
|
63
|
-
|
|
63
|
+
├── lessons/ # Distilled from retrospective insights during archival
|
|
64
|
+
└── changelog.md # Version history — Added, Changed, Fixed, etc.
|
|
64
65
|
```
|
|
65
66
|
|
|
66
67
|
**CRITICAL: Every new page must be added to the sidebar.** The sidebar is configured in a single file: `apps/indusk-docs/src/.vitepress/config.ts` under `themeConfig.sidebar`. If you create a page but don't add it to the sidebar, it is invisible — users cannot navigate to it. This is the most common documentation mistake.
|
|
@@ -79,11 +80,29 @@ Never consider a documentation item complete until the sidebar entry exists.
|
|
|
79
80
|
|
|
80
81
|
| What changed | Where to document | Doc type |
|
|
81
82
|
|---|---|---|
|
|
82
|
-
| New feature or tool | `reference/` | Reference page |
|
|
83
|
-
| New workflow or process | `guide/` | How-to guide |
|
|
84
|
-
| Configuration change | `reference/` (update existing
|
|
85
|
-
|
|
|
86
|
-
|
|
|
83
|
+
| New feature or tool | `reference/` + changelog | Reference page + Added |
|
|
84
|
+
| New workflow or process | `guide/` + changelog | How-to guide + Added |
|
|
85
|
+
| Configuration change | `reference/` (update existing) + changelog | Reference update + Changed |
|
|
86
|
+
| Bug fix | Existing page (if relevant) + changelog | Fixed |
|
|
87
|
+
| Architecture change | `reference/` + diagram + changelog | Reference + diagram + Changed |
|
|
88
|
+
| Nothing user-facing | Skip changelog | — |
|
|
89
|
+
|
|
90
|
+
### Changelog
|
|
91
|
+
|
|
92
|
+
The changelog lives at `changelog.md` in the docs site. It uses [Keep a Changelog](https://keepachangelog.com) categories:
|
|
93
|
+
|
|
94
|
+
- **Added** — new features (from `feature` workflow plans)
|
|
95
|
+
- **Changed** — changes to existing functionality (from `refactor` workflows)
|
|
96
|
+
- **Fixed** — bug fixes (from `bugfix` workflows)
|
|
97
|
+
- **Deprecated** — soon to be removed
|
|
98
|
+
- **Removed** — removed features
|
|
99
|
+
- **Security** — vulnerability fixes
|
|
100
|
+
|
|
101
|
+
**When to write:** During the Document gate of each phase that changes user-facing behavior. Add the entry under `## [Unreleased]`. At publish time, move Unreleased entries into a versioned section.
|
|
102
|
+
|
|
103
|
+
**What to write:** One line per change. Human-readable — what users gain, not what code changed. The workflow type from the impl frontmatter tells you the category (feature → Added, bugfix → Fixed, refactor → Changed).
|
|
104
|
+
|
|
105
|
+
**During planning:** The ADR's Documentation Plan section should include planned changelog entries. This forces you to think about user impact during planning, not after.
|
|
87
106
|
|
|
88
107
|
### Decisions and Lessons
|
|
89
108
|
|