Skip to content

docs: full documentation and guide sweep - #117

Merged
striderZA merged 15 commits into
masterfrom
fix/docs-sweep
Nov 4, 2026
Merged

striderZA merged 15 commits into
masterfrom
fix/docs-sweep

Conversation

@striderZA

Copy link
Copy Markdown
Owner

Summary

Full documentation and guide sweep across the framework, split into 14 atomic commits.

  • Correct setup and onboarding truth: OpenCode 2.x package, one-of OpenCode/Pi/omp, quick-start tree/counts, first-run branding.
  • Remove stale model-tier guidance now that model choice is harness-owned.
  • Correct Pi and omp harness docs: delegation defect, shared hooks, extension counts, native loading boundaries.
  • Repair WORKFLOW-GUIDE appendices and hook guidance; replace the stale AskUserQuestion tool name.
  • Refresh the Godot reference to 4.7.2, fix Unity module links, and set a realistic reference size budget.
  • Fill the core GDD/concept/systems-index/stage/incident templates.
  • Repair the Pi module installer path and stale brainstorm manifest entries.
  • Normalize playtest artifacts to production/qa/playtests across reports, gates, catalogs, and tests.
  • Rewrite UPGRADING.md with a current version index and v0.5-v0.14 migration path.
  • Complete the optional skill-testing-framework catalog: 78 skills, 52 agents, all spec paths present.
  • Align package version, CI triggers, security/conduct reporting, and release-history claims.

Verification

  • node tests/agents/validate.mjs: 209/209 pass
  • node tests/workflow/run-all.mjs: 4/4 suites pass
  • npm test: 177 plugin tests + 54 hook tests pass
  • Link scan across 910 tracked Markdown files: 0 broken links
  • Working tree clean; 14 commits on top of master

Notes

  • Base is master because fix/docs-sweep was created from the current default branch; origin/development has diverged substantially.
  • Module trees are documented as mirrored, not consolidated; consolidation remains a separate change.
  • The Pi delegation defect is documented, not code-fixed.
  • Example transcripts remain historical Godot 4.6 material with a version note.

Correct the OpenCode install package, document one-of OpenCode/Pi/omp, remove OpenCode-only requirements, fix the quick-start tree and counts, and update the first-run product name.
Drop Opus/Sonnet/Haiku labels and the model column; model choice is harness-owned.
Document the delegation defect, remove the barrel and minimatch claims, add ocgs-hooks, and clarify omp loading and Pi baselines.
Regenerate the command appendix, complete the agent appendix, update hook behavior, and replace the stale decision-tool name.
Add the missing workflow case study, replace the stale tool name, and add Bevy, Raylib, SFML, and Godot C# to the coordination map.
Fold the 4.7 changes into the module docs, correct Unity module links, and set a realistic reference size budget.
Add the section structures the consuming skills expect and remove the placeholder release-notes links.
Point init-template at the real installer with --pi, fix the usage text, and correct the stale brainstorm manifest entries.
Use production/qa/playtests across reports, gates, soak tests, workflow catalogs, and examples.
Add the current version index, the v0.5-v0.14 migration path, and mark the old v0.3/v0.4 notes historical.
Match the package version to v0.14.0, run tests on development, and fix the PR test command.
Use private GitHub advisories for vulnerabilities and add a private conduct reporting path.
Fix the omp agent-loading statement and mark the internal changelog as a historical snapshot.
Update counts and spec paths, replace the stale tool name, and add the missing skill and agent specs.
The omp column in the README key-mapping table claimed agents load from
.agents/agents/, contradicting the port-status row and docs/omp-compatibility.md,
which both say omp does not load that roster and its task tool reads .omp/agents/.

The table of contents and docs/framework/hooks-reference.md both linked to
#-hooks-plugin, an anchor no heading produces. The section is now called Plugin
Architecture, and its test table is Hooks Mapping.
@striderZA
striderZA merged commit 24326ea into master Nov 4, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant