agentleFS
8starlabs8starlabs/ui/skills/8sl-component-ship/SKILL.md

8sl-component-ship

Skill143 starsChanged 4 months agoMITView on GitHub

Use when adding, updating, documenting, or validating an 8StarLabs UI component in this repository. Covers the full maintainer workflow across blocks, examples, docs, registry metadata, generated index files, and validation commands.

The file

We split this skill into the rules it gives an agent

12 rules. About 0 are common, 5 are distinctive, and 7 are 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.

  • 7

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Treat component shipping as one workflow.

    line 30
  2. Distinctive:

    Follow existing component patterns before inventing new structure.

    line 33
  3. Distinctive:

    Keep changes minimal and coherent.

    line 35
  4. Distinctive:

    Do not refactor unrelated registry or docs infrastructure unless the current task truly requires it.

    line 36
  5. Distinctive:

    When registry-facing files change, run the generation/build commands instead of assuming metadata still lines up.

    line 39
  6. Very specific:

    Update the component source in registry/8starlabs-ui/blocks.

    line 48
  7. Very specific:

    Update or add example files in registry/8starlabs-ui/examples when the user-facing API or behavior changes.

    line 49
  8. Very specific:

    Update docs in lib/docs/components so installation, usage, and API remain accurate.

    line 51
  9. Very specific:

    Check whether registry.json must be updated or regenerated expectations changed.

    line 53
  10. Very specific:

    Run the registry sync commands when applicable: pnpm registry:generate-index pnpm registry:build

    line 55
  11. Very specific:

    Run additional validation that fits the change, such as pnpm lint or pnpm tscheck, when the edited files could break site or type behavior.

    line 58
  12. Very specific:

    Read references/shipping-checklist.md for repo-specific authoring and validation details.

    line 83

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

8StarLabs Component Ship

Maintainer skill for work inside this repository. Use it when the task is to ship or update a component end-to-end, not when the task is only to consume an already-published registry item in another app.

Apply this skill when

  • adding a new component to the registry
  • updating an existing block, demo, or docs page
  • fixing registry metadata, generated index output, or install targets
  • validating that a component change is shippable

Repo map

  • Component source: registry/8starlabs-ui/blocks
  • Examples and demos: registry/8starlabs-ui/examples
  • Docs content: lib/docs/components
  • Registry manifest: registry.json
  • Generated index: registry/__index__.tsx
  • Generation script: scripts/generate-index.mts

Core rules

  1. Treat component shipping as one workflow. A real change usually touches source, at least one demo, docs, and registry output expectations together.
  2. Follow existing component patterns before inventing new structure. Inspect similar blocks and docs pages first.
  3. Keep changes minimal and coherent. Do not refactor unrelated registry or docs infrastructure unless the current task truly requires it.
  4. Prefer explicit validation. When registry-facing files change, run the generation/build commands instead of assuming metadata still lines up.

Workflow

  1. Inspect the current component and the nearest comparable component in the same repo.
  2. Decide the shipping surface: block only, or block + demo + docs + registry metadata.
  3. Update the component source in registry/8starlabs-ui/blocks.
  4. Update or add example files in registry/8starlabs-ui/examples when the user-facing API or behavior changes.
  5. Update docs in lib/docs/components so installation, usage, and API remain accurate.
  6. Check whether registry.json must be updated or regenerated expectations changed.
  7. Run the registry sync commands when applicable: pnpm registry:generate-index pnpm registry:build
  8. Run additional validation that fits the change, such as pnpm lint or pnpm tscheck, when the edited files could break site or type behavior.
  9. Review generated diffs before finishing. Make sure output matches source intent and no unrelated artifacts slipped in.

Heuristics

  • New block: add source, at least one example, docs page content, and registry entry.
  • API change: update demos and docs in the same pass.
  • Docs-only change: keep code untouched unless docs prove current implementation wrong.
  • Registry/index mismatch: trust generated output after verifying source inputs, not hand-edited drift.

Avoid

  • editing only the block when the public API changed
  • leaving docs or demos stale after changing props or behavior
  • hand-waving registry sync without running the repo commands
  • treating consumer-app integration advice as maintainer workflow

References

  • Read references/shipping-checklist.md for repo-specific authoring and validation details.

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.