agentleFS
Sign inStart free
jocarrdjocarrd/crux-agents/skills/promote-to-docs/SKILL.md

promote-to-docs

Skill4 starsChanged 19 days agoMITView on GitHub

Move to the docs repo what only exists in the conversation, in the agent's local memory or in a commit message, and commit it where it belongs: `decisions/`, `operations/`, `conventions/` or `repos/<repo>/notes.md`. Use when about to write a memory of type project or reference, when you say «esto habría que documentarlo», when a session has uncovered an operational gotcha or a why that isn't left in the code, and before it gets lost on closing.

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    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:

    When in doubt between cross-repo and single-repo, start with single: promoting it later is provided for in the format.

    line 49
  2. Distinctive:

    operations/ and conventions/: if there is already a file on the same topic, add a section.

    line 56
  3. Distinctive:

    If it came from the agent's local memory, delete it along with its line in the index.

    line 66
  4. Distinctive:

    Promoting for the sake of promoting: If the commit already explains it well, it isn't needed.

    line 94

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

promote-to-docs

It moves information from the local, ephemeral scope to the durable one: git.

When to use

  • You are about to save a memory of type project or reference. The standard says those go to git, not to local.
  • A conversation has decided something, discovered a gotcha or fixed a convention that right now is not anywhere durable.

When not to use

  • For memories of type user or feedback: those stay local, they are about the person and not the project.
  • For implementation details the code itself already explains.
  • For everything that occurs to you. Promoting is selective: if in six months it won't help anyone, it isn't worth it.

Flow

1. Identify the piece

  • What is going to be documented, in one or two lines.
  • Which project it belongs to.
  • What type it is: cross-repo decision, single-repo decision, operational, convention or status note.

2. Locate the docs repo

~/Projects/<project>/<project>-docs/. If it doesn't exist, the project is not under the standard yet: use /crux-init or crux adopt first.

3. Decide the destination

TypeDestination
Cross-repo decisiondecisions/index.md, as a new ADR
Single-repo decisionrepos/<repo>/decisions.md
Operational, gotcha, infrastructureoperations/<topic>.md
Cross-cutting code conventionconventions/<topic>.md
A repo's status or contextrepos/<repo>/notes.md

When in doubt between cross-repo and single-repo, start with single: promoting it later is provided for in the format; splitting it is not.

4. Write

  • ADRs: canonical template from decisions/README.md, with the next sequential number of the log where it goes.
  • operations/ and conventions/: if there is already a file on the same topic, add a section; don't create a new one. These folders become useless when every gotcha has its own file.
  • notes.md: dated entries, the most recent on top.

Absolute dates (2026-08-01), never relative: "last week" means nothing when someone reads it in March.

5. Clean up the source

If it came from the agent's local memory, delete it along with its line in the index. Otherwise it stays duplicated in two places that will diverge.

6. Commit

A message that says where it went and what it is:

docs(decisions): add ADR-NNN <title>
docs(operations): document <title>
docs(conventions): add <title>
docs(repos/<repo>): note on <title>

Ask before pushing.

How to tell the type

ClueLikely type
"Why we decided X", affects one reposingle-repo decision
"Why we decided X", affects severalcross-repo decision
"When X happens, do Y" in infrastructure or external dataoperational
"Rule applicable in all repos"convention
"X is blocked because of Y"status note

Anti-patterns

  • Promoting for the sake of promoting. If the commit already explains it well, it isn't needed.
  • Creating a new file when one on the same topic exists.
  • Forgetting to delete the local source.

Related

  • /end-session: the full closing ritual, which includes this
  • /add-repo-to-docs: register a new repo in the project

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.

Check your setup, free