agentleFS
silo-codesilo-code/silo/.agents/skills/silo-docs-sync/SKILL.md

silo-docs-sync

Skill62 starsChanged 59 days agoMITView on GitHub

Use when adding or changing any public @silo-code/sdk symbol — a new ctx method, exported type, or field — or when editing the project positioning / Context7 index. Covers the docs-in-sync workflow (TSDoc, @public/@internal + @category tags, barrel re-export, hand-authored ctx member page, pnpm docs:api, roadmap flip) and how apps/docs is indexed by Context7.

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 0 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    When you add or change a public symbol (a new ctx method, a new type, a new field):

    line 28
  2. Very specific:

    Tag it: Add exactly one of @public / @internal, and a @category (one of: Extension Contract, Registration, Consumer Services, Core Types).

    line 33
  3. Very specific:

    If it's a genuinely public type, re-export it from packages/sdk/src/index.ts (the barrel is the declared surface.

    line 36
  4. Very specific:

    When you expand ExtensionContext (ctx) — the main ongoing work — that is exactly the moment to do all of the above.

    line 57

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Keep docs in sync AS YOU BUILD

The API reference is generated from the source, so documentation is not a separate chore — it's part of changing the code. Whenever you touch the public extension surface, do the documentation in the same change.

The public surface is the @silo-code/sdk barrel packages/sdk/src/index.ts and everything it re-exports (types.ts + the *-service.ts type contracts + context-keys.ts, all under packages/sdk/src/).

The docs site has two layers (see apps/docs/):

  • Hand-authored, member-centric pages — the navigable narrative organized by what you do with ctx: apps/docs/api/index.md (overview + shape diagram), then one subdirectory per ctx domain (apps/docs/api/registration/, apps/docs/api/editors/, apps/docs/api/state/, apps/docs/api/storage/, apps/docs/api/other/, …), one page per ctx member. The apiSidebar in apps/docs/.vitepress/config.ts is the source of truth for the current set of domains.
  • Generated type leaves — TypeDoc renders the SDK types into apps/docs/api/types/ (drill-down targets, linked from the member pages).

When you add or change a public symbol (a new ctx method, a new type, a new field):

  1. Write TSDoc on it — a summary plus per-member docs. Use {@link Other} to cross-reference. Mandatory: every exported public symbol must be documented.
  2. Tag it. Add exactly one of @public / @internal, and a @category (one of: Extension Contract, Registration, Consumer Services, Core Types). @internal keeps host-only exports out of the reference.
  3. If it's a genuinely public type, re-export it from packages/sdk/src/index.ts (the barrel is the declared surface; if it's not in the barrel, it's not public).
  4. If you added a ctx member, add its hand-authored page under apps/docs/api/<domain>/<name>.md (copy an existing one for the shape: blurb → signature → example → type links → see-also) and add it to the apiSidebar in apps/docs/.vitepress/config.ts. Link it from the overview table in apps/docs/api/index.md.
  5. Regenerate the type reference: pnpm docs:api (writes apps/docs/api/types/, committed so growth shows in diffs).
  6. Update the guides in apps/docs/guide/ if the change is user-facing. Guides link to member pages (/api/registration/...) and types (/api/types/...).
  7. Flip its status on the Roadmap from planned to stable (the <Badge>). The roadmap is the source of truth for what's real.

Docs-driven development: the public Roadmap (apps/docs/roadmap.md) is the source of truth for what's real; design decisions live as ADRs (docs/decisions/) and proposals (docs/proposals/). Design a new primitive by adding it to the roadmap as planned (with its sketched surface) first, then implement it and flip it to stable. The roadmap going all-green on core = the inflection point where new features become extensions, not core changes.

When you expand ExtensionContext (ctx) — the main ongoing work — that is exactly the moment to do all of the above. A documented ctx surface is both the invariant #4 burn-down and the docs site growing. They are the same act.

External docs indexing (Context7)

apps/docs is indexed by Context7 (library ID /silo-code/silo) so coding agents can pull Silo's docs directly. What gets indexed and how the project is described there is controlled by the root context7.json — keep its description in sync with README.md / apps/docs/index.md, and keep AGENTS.md's opening + docs/domain-language.md aligned with that same positioning (do not reintroduce older taglines). The context7-refresh job in .github/workflows/docs.yml re-triggers indexing on every push to main.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.