agentleFS
alamenaialamenai/terrae/.claude/skills/docs/SKILL.md

docs

Skill245 starsChanged 9 months agoMITView on GitHub

Generate or update documentation for Terrae components

  • Reads credentials

171 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use import-memory, build-fix and 7 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • amirbironSkill

    import-memory

    Import a memory export from another AI assistant into Claude's memory — conversationally, additively, and with the content treated as data.

    Also in 3 projects that use this

  • diego-tobalinaSkill

    build-fix

    Fix build and compilation errors systematically. Run when build fails.

    Also in 3 projects that use this

  • JkudjoSkill

    incident

    Production incident response — structured triage, hypothesis tree, safe remediation, incident record

    Also in 4 projects that use this

  • vbrevikSkill

    work

    Use when the user says 'plan', 'todo', 'copy plan', 'append plan', 'resume plan', 'priorities', or 'what's next'.

    Also in 7 projects that use this

  • mbwsimsSkill

    impact

    This skill should be used when the user asks to "check the impact", "what will break if I change this", "blast radius", "impact analysis", "what depends on this", "who imports this", "is it safe to change this", mentions "/impact", or wants to understand the consequences of modifying a specific file or function before making changes.

    Also in 3 projects that use this

  • AnthropicSkill

    debug

    Structured debugging session — reproduce, isolate, diagnose, and fix. Trigger with an error message or stack trace, "this works in staging but not prod", "something broke after the deploy", or when behavior diverges from expected and the cause isn't obvious.

    Also in 19 projects that use this

The file

Show its rules and text

We split this skill into the rules it gives an agent

13 rules. 0 are common, 11 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 134 edited versions we read keep these.

  • 11

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

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

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

    Use src/app/docs/lines-animated/page.tsx as the reference for component documentation structure and patterns.

    line 13
  2. Distinctive:

    Ask the user what they need:

    line 18
  3. Distinctive:

    Use Cases grid (exactly 2 use cases, not more)

    line 35
  4. Very specific:

    Use h-full w-full for the container div (NOT fixed heights like h-[400px])

    line 39
  5. Distinctive:

    Always get accessToken from environment variable

    line 41
  6. Distinctive:

    Add new entries at the top with:

    line 61
  7. Distinctive:

    Use code blocks with proper syntax highlighting

    line 67
  8. Distinctive:

    Document all props with types and defaults

    line 70
  9. Distinctive:

    Add visual examples where helpful

    line 71
  10. Distinctive:

    Use DocsCode for inline code references

    line 72
  11. Distinctive:

    Use DocsLink for external links

    line 73
  12. Distinctive:

    Ask for feedback and adjustments

    line 77
  13. Distinctive:

    Only save after user approval

    line 78

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

Docs Skill

Generate or update documentation for Terrae components.

Reference

Use src/app/docs/lines-animated/page.tsx as the reference for component documentation structure and patterns.

Instructions

  1. Determine Documentation Type Ask the user what they need:
    • Component documentation page
    • Weeklog entry
    • README update
    • API reference
  2. For Component Documentation Location: src/app/docs/{component-name}/page.tsx Examples Location: src/app/docs/_components/examples/{example-name}.tsx

    Structure:

    • Title and description (in DocsLayout)
    • Installation section
    • First example (directly after installation, NO title/description)
    • Additional examples (each with DocsSection title and description)
    • Animation Modes or similar feature explanations (if applicable)
    • Properties table
    • Use Cases grid (exactly 2 use cases, not more)
    • Performance Tips
  3. Example Component Patterns
    • Use h-full w-full for the container div (NOT fixed heights like h-[400px])
    • The ComponentPreview wrapper handles sizing
    • Always get accessToken from environment variable
    • Example structure:

      export const ExampleName = () => {
        const accessToken = process.env.NEXT_PUBLIC_MAPBOX_ACCESS_TOKEN || ""
      
        return (
          <div className="h-full w-full">
            <Map accessToken={accessToken} center={CENTER} zoom={10}>
              {/* Component here */}
            </Map>
          </div>
        )
      }
  4. For Weeklog Entries Location: src/app/docs/weeklog/page.tsx

    Add new entries at the top with:

    • Date
    • Summary of changes
    • Links to relevant components
  5. Documentation Patterns
    • Use code blocks with proper syntax highlighting
    • Include working examples
    • Show both basic and advanced usage
    • Document all props with types and defaults
    • Add visual examples where helpful
    • Use DocsCode for inline code references
    • Use DocsLink for external links
  6. Review Process
    • Show the documentation to the user before saving
    • Ask for feedback and adjustments
    • Only save after user approval

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.