write-guide
Skill49 starsChanged 48 days agoApache-2.0View on GitHub
Write or change a skill, reference doc or golden path in this repo so it agrees with the concept graph and is linked to it. Use when adding or editing any SKILL.md, reference/*.md or golden path, and after adding or changing a concept so the docs that cover it are updated too. Pairs with the add-concept skill, which covers the concept files themselves.
6 other projects use a version of this.
Adopted by
Most recently taken up by
- caiopizzol/tres-pinostheir own version, first seen Nov 15, 2026
- karlo-ks/Infradecktheir own version, first seen Nov 15, 2026
- readium/swift-toolkittheir own version, first seen Oct 8, 2026
- henrymbuguak/claude-with-the-anthropic-apitheir own version, first seen Aug 17, 2026
- vercel/next.jstheir own version, first seen May 14, 2026
- sethsontech-max/claudeSkillstheir own version, first seen Apr 3, 2026
Other versions6 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 6
- vercel/next.js★ 143ksame name
- readium/swift-toolkit★ 574same name
- karlo-ks/Infradeck★ 85same name
- caiopizzol/tres-pinos★ 7same name
- sethsontech-max/claudeSkills★ 1same name
- henrymbuguak/claude-with-the-anthropic-api★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository3 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- add-conceptSkill
The file
We split this skill into the rules it gives an agent
8 rules. 0 are common, 3 are distinctive, and 5 are very specific to this project.
0
Common
Most of the 6 edited versions we read keep these.
3
Distinctive
This author's own choices. Worth a look.
5
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 22
Find the concepts it touches: before writing (run these in ontology/tools/):
- Distinctive: line 31
Write from the rules: Every factual claim (a limit, a default, a state, what an action does, what exists) must match a rule.
- Very specific: line 34
If the guide needs a fact that no rule has, add the rule first with the add-concept skill, citing the spec, the public docs or a live probe.
- Distinctive: line 37
If a rule is wrong or out of date, fix the rule (and its evidence) in the same change.
- Distinctive: line 38
Never let a guide and a rule say different things.
- Very specific: line 54
Point to the rules: when a doc is the main explanation of a concept.
- Very specific: line 72
When a rule cites a skill file as evidence and you change that file, re-read the rule: grep -rn "<path>" …
- Very specific: line 77
Follow plugins/runpod/skills/runpod-usage/concepts/README.md → "Writing style" and the repo conventions in AGENTS.md: plain present tense, …
“Common” is measured: kept by at least 6 in 10 of the 6 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.
Files
Write a guide against the concept graph
This repo has two kinds of content that must agree:
- Concepts (
plugins/runpod/skills/runpod-usage/concepts/*.yaml) hold exact facts as rules, each citing a public source. They are the source of truth for what is true. - Guides (every
SKILL.md,reference/*.mdand golden path) explain, teach and demonstrate. They are the source of truth for how to do it.
A guide states facts that the concept rules support, and links to the concepts it covers.
A concept is covered by at least one guide. pnpm check:guides enforces both links.
Writing or changing a guide
Find the concepts it touches before writing (run these in
ontology/tools/):pnpm build:sqlite pnpm query tree "<concept>" # the concept, its children and the guides that cover them pnpm query search "<question>" # the rules that answer a question pnpm query concept "<name>" # every rule on one concept, with evidence- Write from the rules. Every factual claim (a limit, a default, a state, what an action
does, what exists) must match a rule. Explain it in your own words and add the how: the
commands, order, pitfalls and verification.
- If the guide needs a fact that no rule has, add the rule first with the
add-conceptskill, citing the spec, the public docs or a live probe. Then write the guide. - If a rule is wrong or out of date, fix the rule (and its evidence) in the same change.
- Never let a guide and a rule say different things. If you find a disagreement, the public source decides which one changes.
- If the guide needs a fact that no rule has, add the rule first with the
Declare the links.
Guide Where Example SKILL.mdmetadata.conceptsin the frontmatterconcepts: [pod, network-volume]Reference doc a concepts:line in frontmatter at the top---<br>concepts: [runpod-secret]<br>---Golden path lanes,mcp,concepts,status,verifiedandevalsin frontmatter, plus the matching> **Status:**line under the titlesee plugins/runpod/skills/runpod/golden-paths/README.mdList the concepts the guide actually explains or uses, not every word it mentions.
pnpm build:bundle --suggestlists the concepts each golden path names, as candidates. A reference doc that a rule already cites as evidence is linked automatically, but list its concepts anyway when it covers more than the citing rules.- Point to the rules when a doc is the main explanation of a concept. End it with a short
"Exact rules" section with a Markdown link to each concept file (from a reference doc the
target is
../concepts/<id>.yaml). - Route it. A new reference doc gets a row in its skill's
SKILL.mdtable. A new golden path gets rows in the router's table andgolden-paths/README.md.
After adding or changing a concept
pnpm check:guidesfails if the new concept has no guide. Extend an existing doc or write a new one, following the steps above.Find the guides that already cover it and check they still agree with the rules:
pnpm query tree "<concept>" # guides linked to it grep -rln "<name or alias>" ../../plugins/ # guides that mention it without a link- When a rule cites a skill file as evidence and you change that file, re-read the rule:
grep -rn "<path>" ../../plugins/runpod/skills/runpod-usage/concepts/.
Style
Follow plugins/runpod/skills/runpod-usage/concepts/README.md → "Writing style" and the
repo conventions in AGENTS.md: plain present tense, "Runpod", code identifiers in
backticks, no "currently" or "not yet", and positive claims over claims that something is
missing (a missing capability needs the spec or docs as evidence, and CLI absence claims are
checked by hooks/check_cli_absence_claims.py).
Check
cd ontology/tools
pnpm format && pnpm validate --strict && pnpm check:guides && pnpm scan && pnpm test
cd ../.. && python3 hooks/check_links.py && python3 hooks/check_runpod_branding.pycheck:guides must report no errors, and the build line "concepts with a guide" must stay at
every concept.
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
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.

