Contribute to Rig
Rig is a VitePress wiki — content is plain Markdown. Contributing is easy.
What to Contribute
- Fix errors or outdated info: Open a PR with corrections
- Add a playbook: Share a workflow that works for you
- Write a guide: Fill gaps in the documentation
- Report issues: Open a GitHub issue for bugs or suggestions
How to Contribute
- Fork srmdn/rig
- Create a branch:
git checkout -b my-contribution - Write your content in Markdown
- Test locally:
pnpm dev - Run lint:
pnpm lint - Submit a PR
Writing Guidelines
- Keep it beginner-friendly — explain terms, show examples
- Use real, tested workflows — not hypothetical
- Link to other relevant pages
- Follow the existing structure
Content That's Welcome
- Agent configuration examples
- MCP server setups
- Skill recipes
- Model comparison experiences
- Tips, tricks, and gotchas