Agent skill

Docs

by alamenai in alamenai/terrae

Generate or update documentation for Terrae components. An agent skill from alamenai/terrae.

MITAuto-check passedDevelopment

Install Docs

skills CLI
$ npx skills add alamenai/terrae --skill docs -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install alamenai/terrae docs --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/alamenai/terrae.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/docs .claude/skills/docs && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
docs
GitHub stars
245
Token cost
~576 tokens
SKILL.md length
226 words
Files
1
Skills in repo
11
Repo updated
First seen
Licence
MIT

At a glance

Generate or update documentation for Terrae components. An agent skill from alamenai/terrae.

  • Works in 6 steps: Determine Documentation Type → For Component Documentation → Example Component Patterns → …
  • Development work in your project
  • SKILL.md covers Reference and Instructions
  • Needs NEXT_PUBLIC_MAPBOX_ACCESS_TOKEN

What it does

Docs is an agent skill from alamenai/terrae. Generate or update documentation for Terrae components

Its SKILL.md is about 580 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development. It works with Mapbox and React. The repository describes itself as: Composable and animated components that replace imperative layers with simple props. The perfect companion for shadcn/ui. The licence is MIT.

When your agent uses it

  • Development work in your project

Example prompts

  • “/docs”

Requirements

  • A credential in NEXT_PUBLIC_MAPBOX_ACCESS_TOKEN

Workflow steps

6 steps, taken from the first numbered list in SKILL.md.

  1. Determine Documentation Type
  2. For Component Documentation
  3. Example Component Patterns
  4. For Weeklog Entries
  5. Documentation Patterns
  6. Review Process

What it can do on your machine

Read from SKILL.md and the folder at commit ea9a480. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names these keys or tokens, usually read from environment variables:

    • NEXT_PUBLIC_MAPBOX_ACCESS_TOKEN

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Docs loads about 576 tokens when it runs. Until then it costs about 15 tokens; SKILL.md has 226 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~15
When it runs · the whole SKILL.md, loaded when a task matches
~576

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from alamenai/terrae at commit ea9a480, republished under its MIT licence (© alamenai). 226 words, ~576 tokens.

Download SKILL.mdSave it as .claude/skills/docs/SKILL.md (or your agent's skills folder).
name
docs
description
Generate or update documentation for Terrae components
argument-hint
component-name

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:

      tsx
      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

© alamenai, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .claude/skills/docs of alamenai/terrae.

Open the folder on GitHubat commit ea9a480

Compare with similar skills

Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs this skillalamenai/terrae245—~576Automated safety check: PassMIT
Vercel Composition Patternssupabase/supabase111k59 repos~726Automated safety check: PassMIT
Electron Multi-Process ArchitectureiOfficeAI/AionUi33k1 repos~1.8kAutomated safety check: PassApache-2.0
Nx Generatenomcopter/react-mosaic4.8k7 repos~1.9kAutomated safety check: PassCustom licence
@pierre/diffs Code Renderingpierrecomputer/pierre6.2k2 repos~803Automated safety check: PassApache-2.0
OpenTUI Terminal Interfacescline/cline70k—~1.9kAutomated safety check: PassApache-2.0

Similar skills

  • Official

    React composition patterns that scale. An agent skill from supabase/supabase.

    111k GitHub starsUsed in 59 repos~726 tokens
    DevelopmentAuto-check passed
  • Tells the agent where new code belongs in an Electron multi-process project and which APIs each process may use, with rules for new bridges, services, agents and workers.

    33k GitHub starsUsed in 1 repo~1.8k tokens
    DevelopmentAuto-check passed
  • Nx Generate

    nomcopter/react-mosaic

    Generate code using nx generators. An agent skill from nomcopter/react-mosaic.

    4.8k GitHub starsUsed in 7 repos~1.9k tokens
    DevelopmentAuto-check passed
  • @pierre/diffs Code Rendering

    pierrecomputer/pierre

    Guides an agent through using @pierre/diffs to render syntax-highlighted files and diffs, and to build editing and review surfaces in React or plain JavaScript.

    6.2k GitHub starsUsed in 2 repos~803 tokens
    DevelopmentAuto-check passed
  • Helps build terminal user interfaces with OpenTUI using its core imperative API or its React and Solid reconcilers, with references for layout, keyboard, animation and testing.

    70k GitHub stars~1.9k tokensUpdated today
    DevelopmentAuto-check passed
  • Claude Code Skill

    codeaashu/claude-code

    Development conventions and architecture guide for the Claude Code CLI repository.

    3.4k GitHub starsUsed in 1 repo~2.7k tokens
    DevelopmentAuto-check passed

More from alamenai/terrae

All 11 skills in this repo
  • Check

    alamenai/terrae

    Verify all outputs exist after creating a new component and fix any issues

    245 GitHub stars~1.1k tokensUpdated 6 mo ago
    Auto-check passed
  • Fix

    alamenai/terrae

    Systematically fix issues found by /review or reported by the user

    245 GitHub stars~775 tokensUpdated 6 mo ago
    Auto-check passed
  • New

    alamenai/terrae

    End-to-end workflow for building a new Terrae component from scratch

    245 GitHub stars~2.4k tokensUpdated 6 mo ago
    Auto-check passed
  • Perf

    alamenai/terrae

    Audit component performance and identify optimization opportunities with actionable fixes

    245 GitHub stars~678 tokensUpdated 6 mo ago
    Auto-check passed
  • PR

    alamenai/terrae

    Commit, push, and open a pull request on GitHub. An agent skill from alamenai/terrae.

    245 GitHub stars~767 tokensUpdated 6 mo ago
    Auto-check: notes
  • Commit

    alamenai/terrae

    Create standardized git commits following Terrae's conventions

    245 GitHub stars~568 tokensUpdated 6 mo ago
    Auto-check: notes

Works with

Categories

Questions about Docs

What does Docs do?

Generate or update documentation for Terrae components. An agent skill from alamenai/terrae. Docs is an agent skill from alamenai/terrae.

When should I use Docs?

Docs fits situations like: development work in your project.

How do I install Docs in Claude Code?

Run `npx skills add alamenai/terrae --skill docs -a claude-code`. Or copy the skill folder (.claude/skills/docs in alamenai/terrae) into .claude/skills/docs in your project. Claude Code loads it when a task matches its description.

How do I install Docs in Codex?

Run `npx skills add alamenai/terrae --skill docs -a codex`. Or copy the skill folder (.claude/skills/docs in alamenai/terrae) into .agents/skills/docs in your project. Codex loads it when a task matches its description.

Can I use Docs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add alamenai/terrae --skill docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs, .gemini/skills/docs, .github/skills/docs and .opencode/skills/docs in your project.

What does Docs need to run?

Going by SKILL.md and its folder, Docs needs credentials named NEXT_PUBLIC_MAPBOX_ACCESS_TOKEN. Our summary lists: A credential in NEXT_PUBLIC_MAPBOX_ACCESS_TOKEN.

Does Docs access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Docs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Docs use?

Docs is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Docs use?

About 576 tokens (SKILL.md is roughly 2.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Docs?

Skills that share tags, products or a category with Docs: Vercel Composition Patterns (supabase/supabase, 111k stars), Electron Multi-Process Architecture (iOfficeAI/AionUi, 33k stars), Nx Generate (nomcopter/react-mosaic, 4.8k stars) and @pierre/diffs Code Rendering (pierrecomputer/pierre, 6.2k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs?

alamenai (a GitHub user) maintains it in alamenai/terrae, which has 245 GitHub stars. The repository holds 11 skills in this directory. The repository was last updated on April 6, 2026.

Source: alamenai/terrae on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.