Skip to content

docs(slice-44): plain-language docs UX and Setup/Configure framing - #99

Merged
neomatrix369 merged 5 commits into
mainfrom
slice/44-docs-ux-plain-language
Aug 21, 2026
Merged

docs(slice-44): plain-language docs UX and Setup/Configure framing#99
neomatrix369 merged 5 commits into
mainfrom
slice/44-docs-ux-plain-language

Conversation

@neomatrix369

@neomatrix369 neomatrix369 commented Aug 20, 2026

Copy link
Copy Markdown
Owner

Summary

  • Lean README/QUICKSTART with plain-language fold, demo-first (Recommended) then Live (Advanced), badges behind disclosure
  • Merge sie-setup + model-studio-setup into docs/user-guide/tiered-router-setup.md; delete thin aliases onboarding-cheatsheet.md and path-commands.md (net −3 user-guide pages)
  • Absorb glossary / CLI flags / fail hints into reading-router-results, setup-commands, env-vars; docs hub + CONTRIBUTING link agent-hooks
  • Setup vs Configure framing, loud MVP Live, Maintain hub, ARCHITECTURE services inventory + journey/dependency Mermaid (GWT-44.5–44.8)
  • Documentarist pile-on APPROVED WITH FOLLOW-ON: DIVIO rewrites for env-vars procurement table + prerequisites capability bullets DECIDED (same-branch content commit later; merge not held; targets still pending)
  • STATUS/PROGRESS link this PR; gate-evidence pins disposition commit 0362d36

Outcome

Slice 44 docs UX: easier to understand and fewer public guide pages, with Setup (accounts) vs Configure (keys) named consistently and end-to-end service/flow diagrams in ARCHITECTURE. Pile-on review closed as APPROVED WITH FOLLOW-ON — pre-existing DIVIO purity fixes tracked as DECIDED, not merge-blocking.

Test plan

  • GWT-44.1: README fold — metaphor + intent router before badges
  • GWT-44.2: QUICKSTART Recommended demo then Advanced Live
  • GWT-44.3: deleted cheatsheet/path-commands/sie-setup/model-studio-setup; added tiered-router-setup; no live dead links
  • GWT-44.4: Phase 2 absorbed into SSOTs; agent-hooks linked from hub + CONTRIBUTING
  • GWT-44.5: Setup → Configure → Bootstrap; prerequisites Account vs Keys; env-vars Configure framing
  • GWT-44.6: MVP Live callout; Maintain hub row; Daily maintenance cheat lines; skipped-engine gotcha
  • GWT-44.7: screenshots README notes R/Q and colour ≠ density
  • GWT-44.8: ARCHITECTURE External services + operator journey + dependency-order Mermaid; hub/prerequisites links
  • SMOKE_TESTS routes updated
  • Documentarist pile-on APPROVED WITH FOLLOW-ON (QUICKSTART/hub/screenshots OK; DIVIO targets DECIDED pending)
  • STATUS/PROGRESS ↔ PR docs(slice-44): plain-language docs UX and Setup/Configure framing #99; gate-evidence commit_at_evidence: 0362d36

Test Results

Backend (Python)

Tests: 298 passed, 0 failed, 0 skipped (~6s)

Coverage:

Module / Package Statements
sandbox 96.7%
Total 96.72%

CLI (Node)

Tests: 129 passed, 0 failed, 0 skipped (~8s)

Coverage:

Module / Package Statements Branches Methods
All files 98.56% 88.61% 96.66%

Dashboard (Node)

Tests: 86 passed, 0 failed, 1 skipped (~1s)

Coverage:

Module / Package Statements Branches Methods
Total 98.74% 88.62% 97.29%

Quality Gates

Gate evidence: docs/plan/gate-evidence/slice-44.json (verdict: PASS, docs-only, gate_status: ON_BRANCH, review APPROVED_WITH_FOLLOW_ON, commit_at_evidence: 0362d36; HEAD f9552a2)

# Gate Status Detail
1 Tests ✅ passed Docs-only; suites green at PR open (298 / 129 / 86); sync commits did not re-run
2 Line coverage ⏭ N/A docs-only slice (dashboard/CLI still ≥95%)
3 Branch coverage ⏭ N/A docs-only slice
4 Complexity ⏭ N/A no product code
5 Static analysis docs + link retarget; pre-push passed
6 Regression no live links to deleted paths
7 Security scan ⏭ N/A docs-only
8 AT completeness GWT-44.1–44.8 + gate checks
9 Code review ✅ APPROVED WITH FOLLOW-ON nw-documentarist-reviewer; DIVIO env-vars/prerequisites DECIDED pending content commit

Documentation

  • Public docs: compaction + Setup/Configure framing + services/diagrams (README, QUICKSTART, hub, user-guide, ARCHITECTURE, STATUS, screenshots)
  • Plan artifacts: slice stub GWT-44.1–44.8 + DIVIO follow-on DECIDED section; TRAIL/PROGRESS/DECISIONS; gate-evidence APPROVED_WITH_FOLLOW_ON @ 0362d36
  • STATUS ON BRANCH links PR #99; DIVIO content rewrite still pending
  • CHANGELOG Unreleased notes slice 44 pile-ons

Checklist

  • ./scripts/quality-gates.sh passes locally
  • New tests added or updated (or change is docs-only)
  • Docs updated where applicable
  • No secrets or credentials committed

Lean README/QUICKSTART (demo-first), merge SIE/Model Studio into
tiered-router-setup, delete thin aliases, and absorb Phase 2 into SSOTs.
@github-actions

github-actions Bot commented Aug 20, 2026

Copy link
Copy Markdown

code-review-graph review

Overall risk: 0.00 (LOW) — 0 changed function(s)/class(es), 0 affected flow(s), 0 test gap(s)

Token savings: this graph-backed report used ~54,515 fewer tokens (~100%) than reading every changed file in full (estimated, chars/4 approximation).


Powered by code-review-graph — local-first analysis; no code leaves the CI runner.

Name account vs key beats, loud MVP Live, Maintain hub, and ARCHITECTURE
services inventory with journey/dependency Mermaid (GWT-44.5–44.8); sync STATUS.
@neomatrix369 neomatrix369 changed the title docs(slice-44): plain-language docs UX and guide compaction docs(slice-44): plain-language docs UX and Setup/Configure framing Aug 21, 2026
Reword Wave K note so a line no longer begins with '+' (unordered-list rule).
Capture pile-on review disposition and DECIDED DIVIO rewrite shape in plan
SSOTs and STATUS; leave env-vars/prerequisites targets for a later content commit.
Keep STATUS/PROGRESS and slice-44 evidence aligned with the open PR and the
documentarist disposition commit.
@neomatrix369
neomatrix369 merged commit 346fa89 into main Aug 21, 2026
14 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