mirror of
https://github.com/waynesutton/convexskills.git
synced 2026-09-14 16:28:42 +08:00
Wayne Sutton
603b4b858e
- Add templates/skills/ with dev, help, gitrules templates - Add files.md, task.md, docs.md for project tracking - Update changelog with unreleased changes
3.4 KiB
3.4 KiB
Documentation Index
Quick reference to all documentation in this repository.
Getting Started
| Document | Purpose |
|---|---|
| README.md | Project overview, installation, quick start |
| CONTRIBUTING.md | How to contribute to this project |
| LICENSE | Apache-2.0 license terms |
Agent Integration
| Document | Purpose |
|---|---|
| AGENTS.md | Agent skills specification for AI coding agents |
| CLAUDE.md | Claude Code project context |
| GEMINI.md | Gemini CLI integration |
Skills Reference
All skills follow the Agent Skills specification format.
| Skill | What it teaches |
|---|---|
| convex-best-practices | Production patterns, error handling, OCC |
| convex-functions | Queries, mutations, actions, HTTP actions |
| convex-realtime | Subscriptions, optimistic updates |
| convex-schema-validator | Schema definition, typing, validation |
| convex-file-storage | Upload, storage, serving files |
| convex-agents | AI agents with thread management |
| convex-cron-jobs | Scheduled functions, background tasks |
| convex-http-actions | HTTP endpoints, webhooks |
| convex-migrations | Schema evolution, data migrations |
| convex-security-check | Quick security audit checklist |
| convex-security-audit | Deep security review patterns |
| convex-component-authoring | Reusable Convex components |
Templates
Templates for developers to copy when starting new projects or forking.
| Template | Purpose |
|---|---|
| templates/CLAUDE.md | Project context template for Convex projects |
| templates/skills/ | Claude Code skills templates |
Skill Templates
| Template | Purpose |
|---|---|
| templates/skills/dev.md | Full-stack development practices |
| templates/skills/help.md | Problem-solving methodology |
| templates/skills/gitrules.md | Git safety protocols |
Project Tracking
| Document | Purpose |
|---|---|
| changelog.md | Version history |
| files.md | Codebase structure reference |
| task.md | Completed task tracking |
Planning Documents
Located in prds/ directory.
| Document | Purpose |
|---|---|
| skillsplan.md | Skills development roadmap |
| future-skills-exploration.md | Future skills ideas |
| CLAUDE-MD-STRATEGY.md | CLAUDE.md template strategy |
External References
| Resource | URL |
|---|---|
| Convex Documentation | https://docs.convex.dev/ |
| Convex LLMs.txt | https://docs.convex.dev/llms.txt |
| Convex Best Practices | https://docs.convex.dev/understanding/best-practices/ |
| Agent Skills Spec | https://github.com/anthropics/skills |