mosaicstack/stack
1
0
Fork 0
Code Issues 13 Pull Requests Actions Packages Projects Releases 11 Wiki Activity
Files
751e0ee330f81d66a15f13c9ce7c741739d3cbb9
stack/packages/mosaic/framework/templates/docs/DOCUMENTATION-CHECKLIST.md
Jason Woltje b38cfac760
All checks were successful
ci/woodpecker/push/ci Pipeline was successful
Details
ci/woodpecker/pr/ci Pipeline was successful
Details
feat: integrate framework files into monorepo under packages/mosaic/framework/ 
Moves all Mosaic framework runtime files from the separate bootstrap repo
into the monorepo as canonical source. The @mosaic/mosaic npm package now
ships the complete framework — bin scripts, runtime configs, tools, and
templates — enabling standalone installation via npm install.

Structure:
  packages/mosaic/framework/
  ├── bin/          28 CLI scripts (mosaic, mosaic-doctor, mosaic-sync-skills, etc.)
  ├── runtime/      Runtime adapters (claude, codex, opencode, pi, mcp)
  ├── tools/        Shell tooling (git, prdy, orchestrator, quality, etc.)
  ├── templates/    Agent and repo templates
  ├── defaults/     Default identity files (AGENTS.md, STANDARDS.md, SOUL.md, etc.)
  ├── install.sh    Legacy bash installer
  └── remote-install.sh  One-liner remote installer

Key files with Pi support and recent fixes:
- bin/mosaic: launch_pi() with skills-local loop
- bin/mosaic-doctor: --fix auto-wiring for all 4 harnesses
- bin/mosaic-sync-skills: Pi as 4th link target, symlink-aware find
- bin/mosaic-link-runtime-assets: Pi settings.json patching
- bin/mosaic-migrate-local-skills: Pi skill roots, symlink find
- runtime/pi/RUNTIME.md + mosaic-extension.ts

Package ships 251 framework files in the npm tarball (278KB compressed).
2026-04-01 21:19:21 -05:00

1.9 KiB
Raw Blame History

Documentation Completion Checklist

Use this checklist for every task that changes code, API contracts, auth, or operations.

Required Artifacts

  • docs/PRD.md or docs/PRD.json exists and is current
  • docs/USER-GUIDE/ updated as needed
  • docs/ADMIN-GUIDE/ updated as needed
  • docs/DEVELOPER-GUIDE/ updated as needed
  • docs/API/OPENAPI.yaml (or .json) updated for API changes
  • docs/API/ENDPOINTS.md updated for API changes
  • docs/SITEMAP.md updated for navigation changes

API Coverage

  • All public endpoints are documented
  • All private/internal endpoints are documented
  • All API input schemas are documented
  • All API output schemas are documented
  • All endpoint auth/permission requirements are documented
  • Error codes and failure behavior are documented

Structural Standards (Book/Chapter/Page)

  • docs/USER-GUIDE/README.md indexes user chapters/pages
  • docs/ADMIN-GUIDE/README.md indexes admin chapters/pages
  • docs/DEVELOPER-GUIDE/README.md indexes developer chapters/pages

Docs Root Hygiene

  • docs/ root is clean and only contains canonical root docs (PRD, TASKS when active, SITEMAP, optional README) plus category directories
  • Reports are under docs/reports/<category>/ (not docs/ root)
  • Deferred findings are under docs/reports/deferred/
  • Orchestrator learnings are under docs/tasks/orchestrator-learnings.json
  • Release notes are under docs/releases/
  • Archived task snapshots are under docs/tasks/
  • Scratchpads are under docs/scratchpads/

Review Gate

  • Documentation changes are in the same logical change set as code/API changes
  • Code review verified documentation completeness
  • Missing docs were treated as blocker findings

Publishing

  • Publishing target was confirmed with user if unspecified
  • Canonical source remains in-repo unless user explicitly declares otherwise
Reference in New Issue View Git Blame Copy Permalink