agentleFS
theseus-runtheseus-run/theseus/.agents/skills/docs-reading/SKILL.md

docs-reading

Skill1 starsChanged 6 months agoMITView on GitHub

Use before coding or reviewing Theseus runtime, primitive, server, client, or architecture changes when docs may define the intended boundary, status, or domain vocabulary.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

6 rules. About 0 are common, 5 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this skill before code changes when docs may contain the boundary contract.

    line 8
  2. Distinctive:

    If a draft conflicts with current docs or code, current docs/code win.

    line 35
  3. Distinctive:

    Verify before asserting a doc is current.

    line 54
  4. Very specific:

    Do not implement from drafts, brainstorms, or archive unless the user explicitly asks to promote that design.

    line 55
  5. Distinctive:

    When code and active docs disagree, report the mismatch and update docs if the task includes docs maintenance.

    line 57
  6. Distinctive:

    Do not import archived crew, lock-session, queue RuntimeBus, or plugin-host architecture into current runtime work.

    line 59

≈ “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

Theseus Docs Reading

Use this skill before code changes when docs may contain the boundary contract. The goal is to read the right docs without treating drafts or brainstorms as implemented truth.

Read Order

Always start with:

  1. docs/README.md
  2. docs/maps/coding-agent-reading-map.md
  3. the section README for the package or concept you are touching
  4. the nearest current concept note in direction, primitives, runtime, or clients

Then read source code and tests. Docs guide what to inspect; code proves what exists.

Status Semantics

  • direction, primitives, runtime, clients: current doctrine or current implementation notes.
  • drafts: proposals, research, or POCs. Useful context, not authority.
  • brainstorms: speculative ideas. Never implementation authority.
  • archive: superseded history. Read only to avoid reintroducing old paths.
  • design-notes: adopted or active rationale. Use to understand why a current concept exists, then verify against current code.

If a draft conflicts with current docs or code, current docs/code win. Mention the conflict if it affects the task.

Package Pointers

  • Core primitives: docs/primitives/primitives.md, plus the specific note such as tool.md or agent-comm.md.
  • Runtime: docs/runtime/architecture.md, docs/runtime/mission-system.md, docs/runtime/isolation.md, docs/maps/runtime-truth-map.md, and docs/maps/not-real-yet.md.
  • Server: read runtime docs first, then server package code; server is a host adapter, not runtime owner.
  • Client/operator surfaces: docs/clients/README.md and runtime command, control, query contracts.
  • Design changes: also read docs/design-notes/self-editable-harness.md and relevant drafts only if the task is exploring new direction.

Coding-Agent Rules

  • Verify before asserting a doc is current.
  • Do not implement from drafts, brainstorms, or archive unless the user explicitly asks to promote that design.
  • When code and active docs disagree, report the mismatch and update docs if the task includes docs maintenance.
  • Do not import archived crew, lock-session, queue RuntimeBus, or plugin-host architecture into current runtime work.
  • Link docs with relative Markdown links when editing docs.

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.