agentleFS
olorehqolorehq/olore/.claude/skills/build-docs/SKILL.md

build-docs

Skill114 starsChanged 8 months agoMITView on GitHub

Build documentation packages from configs. Downloads docs, filters with AI, generates SKILL.md. Use when setting up or updating local documentation.

4 other projects use a version of this.

Adopted by

Most recently taken up by

  • Other versions4 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 4

    1. CliMA/Oceananigans.jl★ 1.4ksame name
    2. microsoft/semantic-link-labs★ 594same name
    3. NumericalEarth/Breeze.jl★ 90same name
    4. NathanForster/claude-commands★ 1same 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 repository5 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 4 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

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

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

    No args → Process all configs in vault/configs/*.json

    line 25
  2. Very specific:

    If --force flag was set, pass it to subagents:

    line 72
  3. Distinctive:

    All subagents run in parallel.

    line 83
  4. Very specific:

    After install/link, skills are available as /olore-<name>-<version> (e.g., /olore-prisma-latest).

    line 138
  5. Very specific:

    Use --force on any standalone skill to regenerate even if output exists.

    line 149

“Common” is measured: kept by at least 6 in 10 of the 4 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

Build Docs

Build documentation packages from configs in vault/configs/.

Usage

/build-docs                      # All configs, all versions
/build-docs prisma               # All versions for prisma config
/build-docs prisma@latest        # Specific version only
/build-docs prisma zod           # Multiple configs
/build-docs prisma --force       # Re-download even if exists

Workflow

Phase 1: Parse Arguments

Parse $ARGUMENTS:

  • No args → Process all configs in vault/configs/*.json
  • name without @ → All versions for that config
  • name@version → Specific version only
  • --force flag → Re-download even if exists

Phase 2: Discover Work

For each config, list versions and check what needs building:

# List configs
ls vault/configs/*.json

# Get versions from a config
jq -r '.versions | keys[]' vault/configs/{name}.json

# Check if version is built (olore-lock.json exists)
test -f vault/packages/{name}/{version}/olore-lock.json

Built = vault/packages/{name}/{version}/olore-lock.json exists Work = versions without olore-lock.json (unless --force)

Phase 3: Report Plan and Confirm

Show what will be built and ask for confirmation:

Build plan:
  prisma@latest - not built
  zod@latest - exists (skip)
  nextjs@16.1.3 - not built

Will build 2 packages. Proceed?

Phase 4: Spawn Subagents (PARALLEL)

CRITICAL: Spawn ALL subagents in a SINGLE message for parallel execution.

For each package that needs building, spawn a package-builder subagent:

Use package-builder agent: prisma@latest
Use package-builder agent: nextjs@16.1.3

If --force flag was set, pass it to subagents:

Use package-builder agent: prisma@latest --force

Example with 3 packages: In ONE message, spawn THREE subagents:

  • package-builder: prisma@latest
  • package-builder: zod@latest
  • package-builder: nextjs@16.1.3

All subagents run in parallel. Each handles:

  1. Download docs from source
  2. Filter files (if needed)
  3. Generate TOC.md
  4. Generate SKILL.md

Phase 5: Summary

Collect results from all subagents and report:

Build complete:
  ✅ prisma@latest - 312 files (126 filtered), tier 3
  ✅ zod@latest - 17 files, tier 1
  ⏭️  nextjs@16.1.3 - skipped (exists)

Install with: olore install ./vault/packages/prisma/latest

Config Structure

Config file: vault/configs/prisma.json

{
  "name": "prisma",
  "_source": { "type": "github", "repo": "prisma/docs", "path": "content" },
  "versions": {
    "latest": { "ref": "main" }
  }
}

Package Structure (after build)

vault/packages/{name}/{version}/
├── olore-lock.json    # Build metadata
├── SKILL.md           # Skill definition (generated)
├── TOC.md             # Table of contents (generated)
└── contents/
    └── *.md           # Documentation files

After Build

For development (changes immediately visible):

olore link ./vault/packages/prisma/latest

For testing final package (copies to ~/.olore):

olore install ./vault/packages/prisma/latest

After install/link, skills are available as /olore-<name>-<version> (e.g., /olore-prisma-latest).

Standalone Skills

Individual phases can be run independently without the full pipeline:

/download-docs prisma@latest         # Download + filter only
/build-artifacts prisma@latest       # Regenerate SKILL.md + TOC.md only

Use --force on any standalone skill to regenerate even if output exists.

Dependencies:

  • /download-docs has no dependencies (runs first)
  • /build-artifacts requires contents/ from /download-docs

Reference

  • Adding new documentation - Config file format, GitHub/URL sources
  • Conventions - Config vs lock files, naming rules
  • Templates: vault/packages/docs-packager/1.0.0/templates/ (single source of truth)

Requirements

  • jq - JSON parsing
  • git - GitHub cloning
  • curl - URL downloads

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.