Skip to content

alamenai/terrae / .claude/skills/docs

Generate or update documentation for Terrae components

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
brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).Stars: 319kUpdated Claude CodeCodexVerifiedInstall
brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.Stars: 196kUpdated Claude CodeCodexVerifiedInstall
frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.Stars: 196kUpdated Claude CodeCodexVerifiedInstall
mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).Stars: 196kUpdated Claude CodeCodexVerifiedInstall