documenting
SolidThis workspace's architecture-documentation conventions — a package's page is its own README.md, the plain-language house style, which figures are computed rather than written, and the rule that a package's README is updated in the same commit as the change that invalidated it. Use when writing or editing a package README or anything under docs/architecture/, when asked to document a repo or package, and — without being asked — when a change alters what a package is for, how it fits together, or which files matter in it.
Install
Quality Score: 81/100
Skill Content
Details
- Author
- intentic
- Repository
- intentic/intentic
- Created
- 2 weeks ago
- Last Updated
- today
- Language
- TypeScript
- License
- MIT
Similar Skills
Semantically similar based on skill content — not just same category
docs
Create or refresh this repo's README.md, CLAUDE.md and mkdocs.yml, detecting project metadata from git and the manifest. Preserves hand-written prose. Writes files only — no commit, no branch, no PR.
write-docs
Write and edit project docs (README/markdown) as a glossary of principles, not a mirror of the code. Use when creating or revising a README; when a doc enumerates exact scenes, scenarios, helpers, class ids, file lists, or command/flag matrices the code already holds; when trimming narrative or changelog out of a doc; or when deduplicating overlapping docs and wiring a root doc to its sub-docs.
full-document
Full-repo documentation pass — audit what's documented vs what exists, then create and update the repo's docs until it is fully understandable by any future maintainer or LLM. Use for "document the whole repo", "full doc scan", "get this repo documented end to end", or on an unfamiliar/inherited codebase.