Docs Index
Documentation for the current implementation. Start with the repository README for an overview or the user wiki for installation and feature walkthroughs.
#Feature and technical references
| Document | Purpose |
|---|---|
| MCP.md | The opt-in local MCP server for AI assistants: setup, tools, generation setups and connecting clients |
| METADATA_CARRIERS.md | Where generation metadata lives per output format, and what survives |
| NOVELAI.md | NovelAI architecture, personal keys, face detailing, local post-processing and historical test notes |
| RANDOM_PROMPTS.md | Seeded alternation, multiple choices, weights, nesting and escapes |
| STYLE_REFERENCE.md | IP-Adapter/Flux Redux support, model files and controls |
| MACOS.md | Apple Silicon installation, validation and support status |
| IMAGE_TO_3D.md | Experimental Image to 3D: Pixal3D meshes, Idol splats, model files and the viewer |
| YuE2 integration | Native ComfyUI music support, model setup, and validation limits |
| Music studio guide | Covers, reviewed scores, checked edits, MIDI, versions, comparisons and project exports |
| Prompt Assistant account sign-in | ChatGPT and Gemini sign-in, automatic setup, account limits and audio support |
| Video generation methods | Standard, Larryvrh/LightX2V/PDD Turbo, BF16/INT8 VDN and retained 2× drafts |
| ElevenLabs prompting rules | Voice Design and speech rules the anime scene builders follow, with sources and the minor-safety rule |
| Seedance prompting rules | Video prompt rules, provider limits and safety rules the anime scene builder follows |
The wiki also covers music and playlists, video, pause and continue, Style Creator, Image Edit, Anime Scenes, Image to 3D, AI assistants and MCP, and hosted accounts.
#Planning and maintenance
These documents include proposals and historical evidence; they are not promises of available features.
| Document | Purpose |
|---|---|
| ROADMAP-2026-gaps.md | Original gap analysis with current implementation status |
| FEATURE_RESEARCH.md | Historical research shortlist; its ecosystem table is a snapshot |
| Video improvements | Ranked follow-ups, source evidence and GPU qualification plan |
| Automatic music style from audio | Suno evidence, audio conditioning versus metadata reuse, and the first audio-analysis implementation |
| Music generation improvements | Continued Suno, Udio and Lyria 2 research, practical priorities and validation boundaries |
| RTX 5070 video comparison | Measured generation times, motion observations and VDN compatibility failures |
| Cover audio review and timing | Implemented xAI review, timing limits, and the decision to abandon experimental audio timing repair |
| Anime scene pipeline | Original proposal and prototype record for the Scenes page (voiced, animated character clips with ElevenLabs and cloud video), which shipped in v2.3.20; kept as history |
| MACOS_RELEASE_PLAN.md | Apple Silicon release requirements and outstanding qualification gates (DMGs ship with every release since v2.3.9) |
| BOT_REVIEW_TRIAGE.md | Triage notes for automated PR review comments |
| issue_cleanup_followup_tracks.md | Historical issue follow-up tracks |
Local implementation plans and specs may also exist under docs/superpowers/. That directory is git-ignored and is not part of a fresh clone's published documentation.
#Elsewhere
| Topic | Path |
|---|---|
| User-facing readme | README.md |
| Contributing / PR workflow | push-instructions.md |
| Contributor checks / scope | CONTRIBUTING.md, SCOPE.md |
| Changelog / release notes | CHANGELOG.md, RELEASE_NOTES.md |
| Agent entry | AGENTS.md |
| Copilot / Gemini overview | GEMINI.md, .github/copilot-instructions.md |
| Full agent conventions | .github/instructions/mooshieui.instructions.md |
| Layer-specific rules | .github/instructions/ |
| Smoke test runbook | scripts/SMOKE_TEST_RUNBOOK.md |
| Self-host deployment (Docker image, Kubernetes) | deploy/ |
#Keeping documentation current
For a user-facing change, update the relevant wiki page and its navigation, the README if it changes a headline capability or setup step, and any technical reference above. Check the code and shipped release notes for backend/model restrictions and exact control names. Keep dated experiments and plans identified as history rather than rewriting them as current behavior.
The wiki is a separate Git repository (https://github.com/Mooshieblob1/MooshieUI.wiki.git). Changes here do not automatically publish wiki changes, and wiki edits do not update this repository. Check relative links, wiki page names and section anchors in both before publishing.