mit einem Klick
mit einem Klick
| name | docs |
| description | Generate or update documentation for Terrae components |
| argument-hint | ["component-name"] |
Generate or update documentation for Terrae components.
Use src/app/docs/lines-animated/page.tsx as the reference for component documentation structure and patterns.
Determine Documentation Type Ask the user what they need:
For Component Documentation
Location: src/app/docs/{component-name}/page.tsx
Examples Location: src/app/docs/_components/examples/{example-name}.tsx
Structure:
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>
)
}
For Weeklog Entries
Location: src/app/docs/weeklog/page.tsx
Add new entries at the top with:
Documentation Patterns
Review Process
Read a GitHub issue, summarize it, and create a branch for it
Commit, push, and open a pull request on GitHub
Verify all outputs exist after creating a new component and fix any issues
Create standardized git commits following Terrae's conventions
Systematically fix issues found by /review or reported by the user
Run linting and type checking across the Terrae codebase