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

docs-management

Skill1 starsChanged 6 months agoMITView on GitHub

Use when editing the Theseus docs vault under docs/, including adding, moving, splitting, renaming, archiving, cross-linking, changing doc status, or restructuring section indexes.

2 other projects use a version of this.

Adopted by

Most recently taken up by

The file

Show its rules and text

We split this skill into the rules it gives an agent

15 rules. About 0 are common, 7 are distinctive, and 8 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈7

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 8

    Very specific

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

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

    Use this skill whenever you edit docs/.

    line 8
  2. Very specific:

    Do not leave stray top-level folders under docs/.

    line 38
  3. Distinctive:

    Use relative Markdown links, not Obsidian wikilinks.

    line 42
  4. Distinctive:

    After moving files, update obvious links and run a link-resolution check.

    line 58
  5. Distinctive:

    Use short status banners when they prevent confusion:

    line 65
  6. Very specific:

    If a note moves to archive, add or keep a superseded banner.

    line 75
  7. Distinctive:

    Keep active docs accurate against the code.

    line 80
  8. Very specific:

    Keep docs/README.md and section README.md files current.

    line 83
  9. Distinctive:

    Prefer precise links to companion notes over duplicating large explanations.

    line 84
  10. Very specific:

    Do not hand-wave with "future".

    line 85
  11. Distinctive:

    Read the note and linked companion notes.

    line 89
  12. Distinctive:

    Read the relevant source files before changing implementation claims.

    line 90
  13. Very specific:

    Update section indexes and docs/README.md.

    line 94
  14. Very specific:

    Verify no wikilinks remain and all relative .md links resolve.

    line 95
  15. Very specific:

    Before deleting or heavily reducing a note, verify it has no unique durable value.

    line 106

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

Use this skill whenever you edit docs/.

The docs are durable design memory. They must make status obvious: what is current, what is draft, what is speculative, and what is superseded.

Folder Contract

docs/
  README.md
  direction/          current product direction
  primitives/         current primitive and protocol doctrine
  runtime/            current runtime architecture and implementation notes
  clients/            current client/operator surface notes
  drafts/             unadopted design drafts, research notes, and POCs
  brainstorms/        loose speculative ideas
  archive/            superseded designs kept for archaeology
  design-notes/       adopted or active rationale that does not fit a concept note
  maps/               navigation maps for humans and coding agents

Default placement:

  • current truth about implemented or intended architecture: direction, primitives, runtime, clients
  • useful but unadopted design/research: drafts
  • deliberately wild or unvalidated ideation: brainstorms
  • superseded history: archive
  • adopted time-bound rationale: design-notes
  • navigation over existing docs: maps

Do not leave stray top-level folders under docs/.

Link Policy

Use relative Markdown links, not Obsidian wikilinks.

Good:

[architecture](../runtime/architecture.md)
[tool](tool.md)

Bad:

double-bracket link to architecture
double-bracket link to tool

After moving files, update obvious links and run a link-resolution check.

Status Rules

Current notes should say what is true now. Do not mix aspirational behavior into current implementation notes without labeling it as not implemented.

Use short status banners when they prevent confusion:

> Status: current implementation
> Status: active doctrine
> Status: draft
> Status: brainstorm
> Status: SUPERSEDED — see [architecture](../runtime/architecture.md)

If a note moves to archive, add or keep a superseded banner.

Editing Rules

  • One durable concept per note.
  • Keep active docs accurate against the code.
  • Preserve useful history by moving it, not deleting it.
  • Split concept truth from reasoning history.
  • Keep docs/README.md and section README.md files current.
  • Prefer precise links to companion notes over duplicating large explanations.
  • Do not hand-wave with "future"; say not implemented, draft, or brainstorm.

Accuracy Workflow

  1. Read the note and linked companion notes.
  2. Read the relevant source files before changing implementation claims.
  3. Decide the note status: current, draft, brainstorm, archive, or design note.
  4. Move or split the note if its status is wrong for its folder.
  5. Rewrite claims so active docs describe real code and durable doctrine.
  6. Update section indexes and docs/README.md.
  7. Verify no wikilinks remain and all relative .md links resolve.

Useful checks:

rg -n "\\[\\[" docs
bun run docs:check

Preservation Rule

Before deleting or heavily reducing a note, verify it has no unique durable value. Prefer moving to drafts, brainstorms, or archive with a status banner.

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.