unikit-docs

Solid

Generate and maintain the project's TECHNICAL documentation from its codebase — scans the project structure, tech stack, and module boundaries, then writes a lean README landing page plus detailed topic pages (architecture, modules, setup, build, APIs), only the docs that are relevant. Use whenever the user wants to create, update, or validate documentation of the CODE or the project itself, e.g. "generate documentation", "create docs", "write the README", "update the project docs", "document the codebase", "document this project's architecture", "validate the project documentation". This is CODE / project documentation only — it never documents the game design. To render the GAME DESIGN (the GDD: systems, flows, content, economy) for people to read use /unikit-gd-docs.

AI & Automation 16 stars 1 forks Updated 5 days ago MIT

Install

View on GitHub

Quality Score: 84/100

Stars 20%
41
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Docs — Project Documentation Generator Generate, maintain, and improve documentation for game projects following a landing-page README + detailed docs/ structure. ## Core Principles 1. **README is a landing page, not a manual.** ~80-120 lines. First impression, tech stack, quick start, links to details. 2. **Details go to `docs/`.** Each file is self-contained — one topic, one page. 3. **No duplication.** If information lives in `docs/`, README links to it — does not repeat it. 4. **Detection-first.** Scan the project before deciding which documents to generate. Never assume specific frameworks, folder structures, or patterns — discover them. 5. **Navigation.** Every docs/ file has a header line with prev/next links following the Documentation table order. Every page ends with a "See Also" section linking to 2-3 related pages. 6. **Scannable.** Use tables, bullet lists, and code blocks. Avoid long paragraphs. ## Language Awareness — BLOCKING PRE-REQUISITE **BEFORE producing ANY output**, silently read `.unikit/system/LANGUAGE_RULES.md` and apply its rules to ALL subsequent output. If the file is missing or unreadable, fall back to English. Do not produce any user-facing output until language rules are loaded. Do not announce, confirm, or mention the language setting. <!-- unikit:agents codex --> ## Subagent Delegation — BLOCKING PRE-REQUISITE When the workflow reaches a step that requires a subagent (`Agent`), the assistant MUST automatically spawn the subagent if ag...

Details

Author
NintendaDev
Repository
NintendaDev/unikit-ai
Created
3 months ago
Last Updated
5 days ago
Language
Shell
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Solid

unikit-gd-docs

Render the GAME-DESIGN document (the GDD) into a human-readable form — read-only Markdown chapters under docs/design/ (index, systems, flows, content, economy, glossary), with facts resolved inline from GD-IDS.yaml and drafts flagged 🚧. Optional --web also renders an HTML site from the unikit-docs template (falls back to Markdown-only if the template is absent). Use to export or publish the design for people to read, e.g. "render the GDD", "export the game design to docs", "generate readable design docs", "publish the GDD", "make a design doc site". Read-only — it never edits the GDD or registry, only renders it. This renders the game DESIGN — for the project's CODE documentation (README, docs/*, modules, architecture) use /unikit-docs.

16 Updated 5 days ago
NintendaDev
AI & Automation Listed

docs

Generate or refresh project documentation (README sections, module docs, usage guides) from the actual code. Use for "document this", "update the README", "write usage docs".

0 Updated 5 days ago
2Tricky4u
Data & Documents Solid

unikit

Initialize the UniKit framework in a project. Scans the current project to detect the engine and real tech stack, then generates the base framework documents that give AI agents context about the project — the resolved project description, the architecture doc, AGENTS.md, and the user-editable .unikit/config.yaml. This is the one-time, whole-project setup run before any other unikit skill. Use whenever the user wants to initialize, set up, or onboard the framework, e.g. "initialize unikit", "init the framework", "set up unikit", "set up the project", "configure AI context", "scan my project and set it up", "bootstrap the project". This handles the initial full bootstrap — to edit one document later, use that document's dedicated skill.

16 Updated 5 days ago
NintendaDev