documenting

Solid

This 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.

Data & Documents 22 stars 3 forks Updated today MIT

Install

View on GitHub

Quality Score: 81/100

Stars 20%
45
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Documenting a repository **A package's document is its own `README.md`.** It sits next to the code it describes, so the diff that invalidates it and the diff that fixes it are the same diff. Only the repository-level map lives apart: ``` _deploy/graph/ ├── README.md the package's page — the one authored document (authored) ├── package.json └── src/ docs/architecture/ ├── repo.json the map: components, glossary, reading order (authored) ├── repo.md the repository's own page, plain language + figures (authored) └── index.json one-liners, anchors, facts, staleness — GENERATED by `intentic-docs check`. Never write this by hand. ``` There is no per-package JSON sidecar. Everything the app needs to *read* rather than render — the one-liner, the anchors, the size and neighbour facts, whether the page is stale — is derived from the README and from git. `intentic-docs` is on your PATH: ```sh intentic-docs facts --repo intentic # packages, dependency edges, sizes, revisions intentic-docs validate --repo intentic --from published # every package has a README, every anchor resolves intentic-docs check --repo intentic --from published --write # rewrite index.json (staleness, orphans, facts) ``` **`--repo` names a repository under the workspace root, not the directory you are standing in.** It is resolved against `--root` (`/work`), so `cd`-ing into a repository changes nothing a...

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