agentleFS
Cassandra-CollectiveCassandra-Collective/Ephesus/.claude/skills/doc-sync/SKILL.md

doc-sync

Skill2 starsChanged 3 months agoMITView on GitHub

Detect and fix drift between the Ephesus documentation suite and the code — module map vs src/, IPC contract vs handlers, schemas vs validators, invariants vs implementation. Use after landing a milestone, before releases, or when asked whether the docs still tell the truth.

34 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use api-endpoint, perf-budget and 5 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • tadoEngSkill

    api-endpoint

    Add or change a backend API endpoint on this product, keeping Pydantic as the single contract authority and regenerating the TypeScript client. Use when asked to add an endpoint, expose data to the frontend, change a request or response shape, or wire a new backend capability into a page.

    Also in 4 projects that use this

  • vindreshsinghSkill

    perf-budget

    Optimizes performance by measuring first and fixing the real bottleneck. Use when something is slow, before optimizing, when setting latency or bundle targets, or reviewing changes for performance traps — not for speculative micro-tuning.

    Also in 3 projects that use this

  • dillonluiSkill

    design-review

    Review a view or flow for UX and UI issues. Provides severity-ranked, actionable findings grounded in established design heuristics. Use when the user asks for design feedback, UX review, or UI critique.

    Also in 3 projects that use this

  • Microsoft AzureSkill

    design

    Design rules and conventions for the API Center Portal. Use when editing detail pages, card components, badges, layout, navigation, sidebars, or headers. Covers badge styling, metadata placement, page navigation patterns, and layout alignment.

    Also in 3 projects that use this

  • MicrosoftSkill

    release

    Use ONLY when the user explicitly asks to cut/publish a Huabu desktop release or tag a version. Performs an outward action — bumps the version in apps/desktop/package.json, commits + annotated-tags vX.Y.Z, and pushes the branch + tag. That tag push auto-builds the macOS/Windows installers and publishes a GitHub Release. Provides `status`, `bump`, `tag-push`, and a one-command `run` (bump → tag-push).

    Also in 4 projects that use this

  • GoogleSkill

    code-review

    Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.

    Also in 4 projects that use this

The file

We split this skill into the rules it gives an agent

1 rule. 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 26 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Check, in order, reporting each as OK / DRIFT (with file:line on both sides):

    line 11

“Common” is measured: kept by at least 6 in 10 of the 26 edited versions of this file we could read. “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

Documentation ↔ code drift check

The docs are the contract; ENGINEERING-STANDARDS §6.4 says docs move in the same PR as behavior. This skill audits that promise.

Check, in order, reporting each as OK / DRIFT (with file:line on both sides):

  1. Module map — SDD §1.1 table vs actual src/main/ contents (missing modules, undocumented modules).
  2. IPC contract — SDD §5 surface vs handlers registered in src/main/ipc.ts and the preload bridge (missing, extra, or signature-changed entries).
  3. On-disk layout — SDD §2 tree vs what the code actually creates under ~/.ephesus/ (grep for path constants).
  4. Schemas — every schema'd file in SDD §4 has a validator in src/shared/ and the documented fields match the validator's fields; schemaVersion present both sides.
  5. Invariant spot-checks — grep-level tripwires from ENGINEERING-STANDARDS §5: secret reads outside watch/+herald/, writeFile onto live shared paths, hex colors in components, LLM-facing prose literals outside prompts/.
  6. Status honesty — README/PROGRESS claims ("works", "shipped") that nothing in the test suite demonstrates.

Then fix: mechanical drift (tables, lists, signatures) — update the doc in place. Behavioral divergence (code does something the design forbids, or the design needs to change) — do NOT silently rewrite either side; file it as a must-ask or a Gymnasium proposal (/improve) for the Architect. ADRs are never edited — supersede.

Output: a drift table (area · verdict · fix applied / escalated), then commit doc fixes as docs: sync <areas> with code.

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.