docs
Review and update plainworks' documentation so it reads naturally and reflects the kit as it is today — keep Markdown paragraphs flowing without hard column wrapping, preserve intentional structure, s
Files1
View on GitHubSKILL.md.github/skills/docs/SKILL.md
GitHubDocumentation
Apply the baseline. Scope to requested docs and directly affected references, including TSDoc and agent docs.
- Verify scripts/filters against
package.jsonandturbo.json; gates againstinternal/verify; package profiles, exports, and compiler restrictions against current tooling. - Never hand-edit generated layer tables. Use
bun run sync-layer-mapand its check. Preserve core/integration ownership, TS compiler boundary, and locked atoms/deviation ladder. - Lead with the reader's task or capability, then the shortest working example. Use concise active language and clear headings. Keep detail for correct use, contracts, safety, or verification; remove repetition and implementation narration. Changelogs summarize outcomes. Use tables or diagrams only when clearer than prose.
- Markdown paragraphs are not hard-wrapped. TS comments wrap at 100 columns; preserve TSDoc tags/code/paragraphs and use comment-format tooling. Do not blindly join Markdown structure.
- Remove stale usage guidance, not historical changelogs or accepted ADRs. Keep stable docs independent of temporary plans. Recreate stale app screenshots through
ui:capture --docs, then open and judge them; never fabricate images. - Check links/anchors. Typecheck/build the affected package when TSDoc/examples change. Prose-only edits need no application build.
For agent docs, keep startup rules and descriptions short. Skills state actions and acceptance, linking canonical detail rather than repeating it. Preserve hard requirements and validate metadata/links.
Commit only when explicitly requested, using the commit skill.