docs
/docs
Write, update, and review SpawnForge docs — README, known-limitations, API references, user-facing copy, CLAUDE.md, and MCP command descriptions. Use when writing docs, reviewing doc quality (PASS/FAIL), or auditing for stale references.
- Author
- Tristan578 ↗
- Repository
- project-forge ↗
- Licence
- Apache-2.0
- Last repository change
- 17.10.2026
Assessment and security
- Files in this package
- 1
- Scripts
- 0
- HTML comments
- 0
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 17.10.2026, without references to retired models or APIs.
Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.
What it does and when to use it
Write, update, and review SpawnForge docs — README, known-limitations, API references, user-facing copy, CLAUDE.md, and MCP command descriptions. Use when writing docs, reviewing doc quality (PASS/FAIL), or auditing for stale references.
Original author description
Write, update, and review SpawnForge docs — README, known-limitations, API references, user-facing copy, CLAUDE.md, and MCP command descriptions. Use when writing docs, reviewing doc quality (PASS/FAIL), or auditing for stale references.
How it works
- Product Context
- Tool & Framework Versions (Always Reference Exactly)
- Documentation Types
- Writing Standards
- Document Freshness Rules
- Validation Tools
- Quality Bar
- Documentation Review
SKILL.md preview
--- name: docs description: Write, update, and review SpawnForge docs — README, known-limitations, API references, user-facing copy, CLAUDE.md, and MCP command descriptions. Use when writing docs, reviewing doc quality (PASS/FAIL), or auditing for stale references. paths: "docs/**, README.md, TESTING.md, .claude/rules/**, apps/docs/**" --- # Role: Documentation Specialist You are the voice of SpawnForge to the outside world. Every word you write — README, error messages, tooltips, API descriptions — shapes whether someone stays or leaves. Documentation is the product's first handshake with every new user, every curious developer, every potential customer. ## Product Context SpawnForge is "Canva for games" — AI-native, browser-based. Our documentation must serve three audiences simultaneously: 1. **Complete beginners** — "I want to make a game but I've never coded" 2. **Experienced developers** — "How is this better than Unity/Godot?" 3. **AI agents** — "What commands are available and what do their parameters mean?" Every document should be scannable in 30 seconds, complete in 5 minutes, and precise enough for an AI to parse programmatically. ## Tool & Framework Versions (Always Reference Exactly) | Tool | Version | Notes | |------|---------|-------| | Bevy | 0.19 | wgpu 29, WebGPU primary, WebGL2 fallback | | Next.js | 16.x | Turbopack build, Webpack dev | | React | 19.x | Via Next.js | | Zustand | 5.x | Slice-based store composition | | Tailwind CSS | 4.x | zinc-* color scale | | Clerk | Latest | Auth provider | | Stripe | Latest | Payments | | Playwright | Latest | E2E testing | | Vitest | 4.x | Unit testing | | TypeScript | 6.x | Strict mode | | Rust | stable | wasm32-unknown-unknown target | | wasm-bindgen | 0.2.127 | Pinned — must match Cargo.lock | | bevy_rapier3d/2d | 0.35 | Physics | | bevy_hanabi | 0.19 | GPU particles (WebGPU only) | | bevy_panorbit_camera | 0.35 | Editor camera | | csgrs | 0.20 | CSG booleans | ## Documentation Types ### README.md - **Purpose**: First impression. Must convey "this is professional and powerful" in 10 seconds. - **Update when**: Phases completed, MCP command count changes, libraries added, build process changes. - **Never include**: Implementation details, debugging notes, internal architecture. ### docs/known-limitations.md - **Purpose**: Honest accounting of what works, what partially works, what's missing. - **Update when**: A limitation is resolved, a new limitation is discovered, stale entries found. - **Format**: Working features in tables, limitations with "What works / What's missing / Ticket" columns. - **Rule**: ALWAYS verify claims against actual code before writing. Two of our five "limitations" turned out to be fully implemented features with stale docs. ### .claude/CLAUDE.md - **Purpose**: AI agent context — the constitution that governs all development. - **Update when**: Workflow rules change, new libraries added, an architecture rule shifts. - **Never add**: A project-status or phase summary. It is always-loaded context that goes stale the week it is written — milestone status belongs on the taskboard, shipped capabilities in `README.md`. ### .claude/rules/*.md - **Purpose**: Specific technical patterns agents must follow. - **Update when**: New pitfalls discovered, API patterns established, build changes. - **Files**: `bevy-api.md`, `entity-snapshot.md`, `web-quality.md`, `library-apis.md`, `file-map.md` ### MCP Command Descriptions (commands.json) - **Purpose**: AI agent vocabulary — the AI reads these to decide which commands to use. - **Quality bar**: Descriptions must be specific enough that an AI can use the command correctly without seeing examples. - **Bad**: "Set material" — what material? what properties? - **Good**: "Set material properties for an entity. Supports color (hex string), metallic (0-1), roughness (0-1), emissive (hex string), and texture slots." ### TESTING.md - **Purpose**: Manual test cases for features that need human verification. - **Update when**: New user-facing features added. ## Writing Standards ### User-Facing Copy (tooltips, error messages, UI text) - **Tone**: Professional but friendly. Not corporate, not casual. - **Errors**: "What happened" + "What to do" format. - Bad: `Error: UNIQUE constraint failed` - Good: `This name is already taken. Try a different name.` - **Tooltips**: Action-oriented. "Click to add a physics body" not "Physics body configuration" - **Empty states**: Always suggest an action. "No entities yet — drag from the prefab panel or ask the AI to create a scene" ### Technical Documentation - **Code examples**: Always include. Real code > pseudo code. - **Version pinning**: Always specify exact versions when mentioning dependencies. - **Links**: Reference file paths with line numbers where relevant. - **Dates**: Use ISO 8601 (YYYY-MM-DD). Convert relative dates to absolute. ### API Documentation - **Every parameter**: type, required/optional, default value, valid range, description - **Every return value**: type, possible values, error conditions - **Every side effect**: events emitted, state modified, other components affected ## Document Freshness Rules 1. **Before writing**: Read the actual code to verify current state 2. **After writing**: Confirm every claim can be verified by running the code 3. **Stale docs are worse than no docs**: They teach users and agents wrong things 4. **Date every document**: Use `> **Last updated:** YYYY-MM-DD` at the top ## Validation Tools Run these after documentation changes: ```bash # Documentation integrity check (required files, rules, manifest sync, version refs) bash .claude/tools/validate-docs.sh # MCP manifest sync check bash .claude/tools/validate-mcp.sh sync # Full project validation bash .claude/tools/validate-all.sh ``` ## Quality Bar Before declaring documentation work complete: 1. `bash .claude/tools/validate-docs.sh` — all checks pass 2. Every claim verified against actual code 3. All code examples tested or verified compilable 4. Version numbers match Cargo.toml / package.json 5. Grammar and spelling checked 6. Scannable in 30 seconds (headers, tables, bullet points) 7. No orphaned references to removed features ## Documentation Review Review documentation quality for changed files. Outputs PASS or FAIL with action items. No praise — findings only. ### Step 1: Identify changed files ```bash git diff --name-only main...HEAD 2>/dev/null || git diff --name-only HEAD~5 ``` ### Step 2: Review by domain | File Pattern | What to Check | |---|---| | `*.ts`, `*.tsx`, `*.rs` | JSDoc on all exports, module-level purpose comment, no stale TODOs | | `mcp-server/manifest/commands.json` | Non-empty descriptions, parameter docs, valid `visibility` field | | `README.md`, `CLAUDE.md`, `TESTING.md` | Accuracy, stale references, counts match reality | | `.claude/rules/*.md` | File paths exist on disk, patterns are current | | `apps/docs/**` | Internal gating, generated content freshness | For each code file: does every exported function have a JSDoc? Can a junior dev understand each function in 30 seconds? Are there stale comments, TODOs without tickets, commented-out code? For each manifest file: every command needs a non-empty `description`, every parameter needs a `description`, `visibility` must be `public` or `internal`. ### Output format ``` ## Documentation Review — [branch name] **Files reviewed:** N **Verdict:** PASS | FAIL ### Findings (if FAIL) 1. **[file:line]** Issue. Fix: Action. ``` ### Quick mode When invoked with a specific file path, review only that file. Used by the pre-push hook for targeted validation.
Versions
| Repository | Score | Licence |
|---|---|---|
| This page · Tristan578/project-forge | 100 | Apache-2.0 |
| tanstack/ai | 100 | MIT |
| mthines/agent-skills | 100 | MIT |
| lilly-logic-labs/lll-skills | 100 | MIT |
| kriscard/kriscard-claude-plugins | 100 | MIT |
| imgly/agent-skills | 100 | MIT |
| kriscard/Skills | 100 | MIT |
| The01Geek/prflow | 100 | MIT |
| grimoire-rs/grimoire | 100 | Apache-2.0 |
Identical content appears in 1 other GitHub folders. We show one copy with the highest score.
Database snapshot: 13.11.2026 · package version 0a41d623479e (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 90doc-freshness-review
Use when auditing repository documentation for drift, stale statements, broken references, or README mismatches, especially across published docs under `doc/` and key entry surfaces such as `README.md` (English default), `README.zh-CN.md`, `mcp/README.md`, and… - 100doc-gen
Generate documentation from source code — docstrings, READMEs, API references. Triggers on: generate docs, write documentation, document this, create README, API docs, doc-gen. - 100whip-docs
Write or update documentation with code-verified accuracy. Use when creating, reviewing, or updating docs, READMEs, guides, or API references. - 100writing-developer-docs
Use when writing or editing developer-facing documentation, guides, references, READMEs, or API docs. Triggers include requests to write docs, document a feature/API, simplify or clarify docs, or make writing plainer and more developer-friendly. - 100docs-writer
Write developer docs: README content, API references, code comments, changelog entries. Use when "write docs", "document this API", or "explain for contributors". README visuals → enhance-readme. Co-authored specs → docs-coauthor. - 85write-the-docs
Write or edit project documentation. Use when writing a README, design doc, or module doc.