Documentation

Two folders, two purposes:

docs/
├── api/          # Starlark API - what you can call
└── guides/       # How to build meowg1k

Pick your path

Want to use meowg1k?

• API Reference - All Starlark functions with examples
• Starlark Guide - Write custom commands

Want to contribute?

• Architecture - Why we built it this way
• Go Conventions - Code style rules
• Testing - How to test your changes
• UI Patterns - Build terminal interfaces

Building autonomous agents?

• Agentic System - Multi-step workflows

First steps

1. Install meowg1k (see root README.md)
2. Create .meowg1k/init.star (Starlark Guide shows how)
3. Browse the API to see what you can do
4. Copy examples from .meowg1k/commands/

Updating docs

Changed the code? Update the docs:

• Code changes → update API_REFERENCE.md
• New patterns → update relevant guide
• Complex features → add examples

Read CONTRIBUTING.md before you start.