@jstn-sdk/ma 0.1.5 → 0.1.7

package/docs/getting-started.md

@@ -1,24 +1,169 @@
 # Getting Started
 
-Meta-Architect is a Codex-native runtime layer. Install Codex, install Meta-Architect, launch the runtime posture, then operate through skill tags inside Codex.
+This guide takes Meta-Architect from install to a green-gated skill workflow on a real project.
 
-## Canonical path
+## Goal
 
-Install:
+By the end of this guide you should be able to:
+- install Meta-Architect
+- configure MCP/GitMCP sources
+- run the full architecture-to-build sequence
+- understand how each gate moves
+- diagnose blocked gates
+- use the merge/release path safely
+
+## Prerequisites
+
+- Node.js 20+
+- npm 10+
+- Git 2.30+
+- an MCP-capable runtime
+- network access if you want live `$sage` verification against a real GitMCP server
+
+## 1. Canonical install and launch
+
+Canonical public install:
 
 ```bash
-npm i -g @openai/codex @jstn-sdk/ma
+# Install
+npm i -g @openai/codex@latest @jstn-sdk/ma@latest
+
+# Launch
+ma --madmax --high
+
+# Remove Meta-Architect only
+npm uninstall -g @jstn-sdk/ma
+
+# Remove Meta-Architect and Codex
+npm uninstall -g @jstn-sdk/ma @openai/codex
 ```
 
-Launch:
+That is the default product path. The product experience is the in-session skill workflow in [example/usage-workflow.md](../example/usage-workflow.md). The `ma` command is only a helper for starting or supporting that flow.
+
+## 2. Real usage workflow
+
+Start with the structured `$arch` prompt:
+
+```text
+$arch I want to build: [PROJECT IDEA]
+
+Context:
+- Product type: [web app / mobile app / API / marketplace / agent system / internal tool]
+- Users: [who will use it]
+- Core problem: [what problem it solves]
+- Main features:
+  1. [feature one]
+  2. [feature two]
+  3. [feature three]
+- Constraints:
+  - Budget: [low / medium / high]
+  - Team size: [solo / small / medium]
+  - Timeline: [e.g. 2 weeks MVP, 3 months beta]
+  - Preferred stack: [optional]
+  - Avoid: [optional]
+- Quality priorities:
+  - [e.g. speed, low cost, security, DX, maintainability, scalability]
+- Deployment target:
+  - [Vercel / Docker / VPS / AWS / GCP / local-first / hybrid]
+
+Required output:
+1. Problem framing
+2. Recommended architecture
+3. Stack decision with justification
+4. System components and responsibilities
+5. Data model and storage choices
+6. Auth/security considerations
+7. DX/UX considerations
+8. Delivery plan for v0.1.7
+9. Risks and trade-offs
+10. Decision log
+11. Exact next trigger to run after this
+```
+
+Then continue with:
+
+```text
+$sage
+$flow
+$vet
+$vibe
+$build
+```
+
+Use the full prompt blocks from [example/usage-workflow.md](../example/usage-workflow.md) when you want the exact handoff format between lanes.
+
+## 3. Contributor clone and link
 
 ```bash
-ma --madmax --high
+git clone https://github.com/JustineDevs/meta-architect.git
+cd meta-architect
+npm install
+npm link
+```
+
+Why `npm link` matters:
+- it makes the local helper command available without requiring a global publish step
+
+## 4. Secondary repository setup flow
+
+```bash
+ma setup
+```
+
+Optional interactive session:
+
+```bash
+ma
 ```
 
-Operate inside Codex with:
+Expected effects:
+- `.codex/agents/` exists
+- `.codex/prompts/` exists
+- local `.ma/skills/`, `.ma/evidence/`, `.ma/context/`, `.ma/specs/`, `.ma/plans/`, and `.ma/runbook.md` are seeded
+- `mcp/`, `docs/`, and `sprint/` surfaces exist
+- `ma` opens Codex with the Meta-Architect helper posture when run with no arguments
+
+Expected output:
 
 ```text
+meta-architect setup
+====================
+ready: .codex/agents
+ready: .codex/prompts
+ready: .ma/skills
+ready: .ma/evidence
+ready: .ma/context
+ready: .ma/specs
+ready: .ma/plans
+ready: mcp
+ready: docs
+ready: docs/qa
+ready: sprint
+```
+
+This setup path is secondary to the canonical in-session skill workflow. Use it when you need local repo scaffolding.
+
+## 4.1 Understand the two surfaces
+
+Meta-Architect works in two simple ways:
+
+- terminal commands
+- in-session skills
+
+Terminal commands are normal shell commands:
+
+```bash
+ma setup
+ma init
+ma sdk-path
+ma status
+ma run '$arch'
+```
+
+In-session skills are prompts used after you are already inside Codex:
+
+```text
+$maestro
 $arch
 $sage
 $flow
@@ -27,62 +172,314 @@ $vibe
 $build
 ```
 
-## Runtime expectations
+Easy rule:
+- `ma ...` = terminal helper command
+- `$...` = in-session skill
 
-- Codex is the host runtime.
-- Meta-Architect is the runtime extension.
-- The skill tags are the primary product surface.
-- `ma` is a runtime launcher plus a small maintenance/helper interface.
+`ma setup` and `ma init` currently do the same thing:
+- they create local `.ma/` support files
+- they prepare context, specs, plans, evidence, and runbook files
+- they do not automatically run the skill workflow
 
-## When to use helper commands
+`ma sdk-path` prints the installed packaged support-bundle root for relevant files such as prompts, MCP files, sprint files, scripts, plugin metadata, and templates.
 
-Use helper commands only when you need scripted repo validation or repo-local scaffolding:
+## 5. Configure MCP / GitMCP
+
+Edit:
+- `mcp/servers.json`
+- `mcp/collections.json`
+- `mcp/fallback.json`
+
+Minimum live example:
+
+```json
+{
+  "category": "meta-list",
+  "repo": "sindresorhus/awesome",
+  "endpoint": "https://gitmcp.io/sindresorhus/awesome"
+}
+```
+
+Recommended first set:
+- `sindresorhus/awesome`
+- `dzharii/awesome-typescript`
+- `sbilly/awesome-security`
+
+Core discovery standard:
+- use `https://ossium.live/home` to find trending OSS, curated repos, YC-backed repos, GSoC orgs, and contribution leads faster than browsing GitHub directly
+- use `https://trendshift.io/` to spot repositories with rising engagement and topic momentum
+- use `https://devhunt.org/` to discover newly launched developer tools
+- use `https://libraries.io/` to inspect package/dependency metadata, while remembering its public data is scraped and not validated/curated for accuracy
+- use `https://openhub.net/` to inspect project activity, contributor, popularity, and comparison signals
+- use `https://www.opensourceprojects.dev/` to inspect curated OSS selections and detailed project writeups
+- move any promising discovery result into `mcp/servers.json` as an exact upstream GitMCP repo endpoint before treating it as VERIFIED evidence
+
+Canonical `$sage` order:
+- known upstream repo/docs first
+- discovery accelerators second
+- exact GitMCP repo mapping third
+- upstream repo + official-doc verification last
+
+See [docs/mcp-setup.md](./mcp-setup.md) for endpoint policy and evidence semantics.
+
+## 6. Secondary helper flow
+
+```bash
+ma idea "Build a real-time collaborative whiteboard for product teams"
+```
+
+Expected effects:
+- an idea decision entry is appended to `.ma/decisions.json`
+- `idea_status = CLEAR`
+
+If this fails:
+- ensure the idea text is not empty
+- inspect `.ma/decisions.json` for malformed local data
+
+## 7. Run the helper skill sequence
+
+### 5.0 Workflow manager
+
+```bash
+ma run '$maestro'
+```
+
+Expected effects:
+- reads the current gate state
+- recommends the best next step
+- writes `.ma/plans/maestro.md`
+- records an advisory decision entry
+
+Generated or updated:
+- `.ma/decisions.json`
+- `.ma/plans/maestro.md`
+
+### 5.1 Architecture
 
 ```bash
-ma status
-ma idea "Build a real-time collaborative whiteboard"
 ma run '$arch'
+```
+
+Expected effects:
+- a structured first-pass architecture blueprint is appended
+- `architecture_status = APPROVED`
+
+Generated or updated:
+- `.ma/decisions.json`
+- `.ma/release.json`
+- `.ma/context/project.md`
+- `.ma/specs/architecture.md`
+- `.ma/plans/implementation.md`
+
+### 5.2 Evidence
+
+```bash
 ma run '$sage'
+```
+
+Expected effects:
+- `architecture_status` must already be approved
+- configured GitMCP endpoints are validated
+- the latest architecture summary is used as the probe query basis
+- the first configured live source is probed when live mode is enabled
+- `.ma/evidence/sources.json` is updated
+- `evidence_status` becomes:
+  - `VERIFIED` on a real successful live probe
+  - `PARTIAL` when configured evidence exists but live proof is incomplete or disabled
+  - `MISSING` when no usable approved source exists
+
+Generated or updated:
+- `.ma/evidence/sources.json`
+- `.ma/decisions.json`
+- `.ma/release.json`
+- `.ma/specs/evidence.md`
+
+If this fails:
+- check endpoint URLs in `mcp/servers.json`
+- ensure architecture was approved first
+- verify network access
+- rerun after correcting the endpoint or environment
+
+### 5.3 Logic
+
+```bash
 ma run '$flow'
+```
+
+Expected effects:
+- a structured first-pass logic/state review is appended
+- `logic_status = GREEN` when current prerequisites and transition modeling are acceptable
+- `logic_status = RED` when prerequisite gates are not ready
+
+Generated or updated:
+- `.ma/specs/logic.md`
+
+### 5.4 Security
+
+```bash
 ma run '$vet'
+```
+
+Expected effects:
+- `.ma/evidence/audits.json` and `.ma/evidence/cves.json` are updated
+- `security_status = GREEN` on a baseline pass
+- `security_status = RED` when prerequisite gates are not ready
+
+Generated or updated:
+- `.ma/specs/security.md`
+
+### 5.5 Experience
+
+```bash
 ma run '$vibe'
+ma run '$vibe' --waive --reason "Accepted for this release line"
+```
+
+Expected effects:
+- `.ma/evidence/outcomes.json` is updated
+- `experience_status = GREEN` on a baseline pass
+- `experience_status = RED` when prerequisite gates are not ready
+- `experience_status = WAIVED` when the waiver path is used explicitly
+
+Generated or updated:
+- `.ma/specs/experience.md`
+
+## 8. Inspect gate status
+
+```bash
+ma status
+```
+
+Expected green-state output:
+
+```text
+Meta-Architect Status
+=====================
+Idea: CLEAR
+Architecture: APPROVED
+Evidence: VERIFIED
+Logic: GREEN
+Security: GREEN
+Experience: GREEN
+Build: LOCKED
+Next allowed triggers:
+$build
+```
+
+## 9. Unlock and run build planning
+
+```bash
 ma run '$build'
-ma doctor
+```
+
+Expected effects:
+- build gate is evaluated
+- if allowed, `build_status = READY`
+- branch suggestions are printed
+- worktree commands are suggested
+- `.ma/plans/build.md` is updated
+
+Expected output shape:
+
+```text
+Build gate is green.
+Suggested branches:
+- feature/ui
+- feature/api
+Optional worktree commands:
+git worktree add ../ui feature/ui
+git worktree add ../api feature/api
+```
+
+If `$build` fails:
+- run `ma status`
+- read the blocking statuses
+- fix the corresponding upstream lane
+- rerun that lane, then rerun `$build`
+
+## 10. Example walkthrough: collaborative whiteboard
+
+```bash
 ma setup
+ma idea "Build a collaborative whiteboard with live cursors and shared boards"
+ma run '$arch'
+ma run '$sage'
+ma run '$flow'
+ma run '$vet'
+ma run '$vibe'
+ma status
+ma run '$build'
 ```
 
-`ma setup` repairs or seeds repo-local support files such as:
-- `AGENTS.md`
-- `.codex/`
-- `.omx/`
-- `mcp/`
-- `templates/`
+If you want an interactive Codex session during the walkthrough, start it separately with `ma`.
 
-That path is secondary. The main experience remains the Codex session launched with `ma --madmax --high`.
+What should happen:
+- `$arch` records a structured first-pass blueprint
+- `$sage` binds major choices to configured GitMCP-backed sources
+- `$flow` records the kernel’s baseline state review for the mission
+- `$vet` records a baseline security review
+- `$vibe` records baseline DX/UX guidance
+- `$build` suggests bounded concerns like `feature/ui` and `feature/api`
 
-## MCP / GitMCP
+Related mission:
+- [missions/collaborative-whiteboard/mission.md](../missions/collaborative-whiteboard/mission.md)
 
-Meta-Architect expects approved GitMCP endpoints for evidence-heavy lanes such as `$sage`.
+## 9. Merge and release path
 
-Edit:
-- `mcp/servers.json`
-- `mcp/collections.json`
-- `mcp/fallback.json`
+After implementation work is complete:
+
+```bash
+ma merge feature/ui development
+ma release development prod
+```
+
+Expected effects:
+- merge only succeeds for `feature/* -> development`
+- release only succeeds for `development|release/* -> prod`
+- final statuses advance to:
+  - `build_status = DONE`
+  - `merge_status = MERGED_TO_DEVELOPMENT`
+  - `release_status = SHIPPED_TO_PROD`
+
+## 10. Files generated or updated during a normal run
+
+- `.ma/decisions.json`
+- `.ma/release.json`
+- `.ma/evidence/sources.json`
+- `.ma/evidence/audits.json`
+- `.ma/evidence/cves.json`
+- `.ma/evidence/outcomes.json`
+- `.ma/context/project.md`
+- `.ma/specs/architecture.md`
+- `.ma/specs/evidence.md`
+- `.ma/specs/logic.md`
+- `.ma/specs/security.md`
+- `.ma/specs/experience.md`
+- `.ma/plans/implementation.md`
+- `.ma/plans/build.md`
+- `.ma/runbook.md`
 
-See [docs/mcp-setup.md](./mcp-setup.md) for exact-endpoint policy and fallback rules.
+These are local product artifacts created by the runtime. They are not a reason to bypass gate logic manually.
 
-## Release-aware usage
+## 11. If a gate fails
 
-`$build` is locked until all upstream review gates are green or explicitly waived by policy.
+Rule:
+- do not edit statuses manually
+- rerun the correct upstream command
+- use `ma status` as the authority
 
-Before claiming a release is ready, make sure:
-- `npm run release:check` passes
-- [docs/release-spec.md](./release-spec.md) still matches behavior
-- [docs/qa/release-readiness-0.1.5.md](./qa/release-readiness-0.1.5.md) matches the actual release line
+Common examples:
+- `evidence_status = MISSING` -> fix `mcp/servers.json`, rerun `$sage`
+- `logic_status = RED` -> fix upstream evidence/architecture issues, rerun `$flow`
+- `security_status = RED` -> resolve issues surfaced by `$vet`
+- `experience_status = RED` -> rerun `$vibe` after clearing prerequisites
+- `experience_status = WAIVED` -> verify the waiver reason recorded in `.ma/release.json`
 
 ## Related docs
 
+- [README.md](../README.md)
 - [Skills Reference](./skills.md)
 - [MCP Setup](./mcp-setup.md)
 - [Release Spec](./release-spec.md)
+- [Skills Publishing](./skills-publishing.md)
 - [Plugin Bundle](../plugins/meta-architect/README.md)

package/docs/installed-sdk.md

@@ -0,0 +1,60 @@
+# Installed Support Bundle
+
+Meta-Architect installs two things into the active Codex home:
+
+1. skills under `CODEX_HOME/skills/`
+2. a support bundle under `CODEX_HOME/meta-architect-sdk/`
+
+The support bundle exists so skills and helper paths can use relevant packaged files without guessing where they live.
+
+## Canonical support bundle path
+
+Default:
+
+```text
+~/.codex/meta-architect-sdk/
+```
+
+If `CODEX_HOME` is set, use:
+
+```text
+$CODEX_HOME/meta-architect-sdk/
+```
+
+You can print the exact active path with:
+
+```bash
+ma sdk-path
+```
+
+## What is installed there
+
+- `mcp/`
+- `sprint/`
+- `prompts/`
+- `scripts/`
+- `plugins/meta-architect/`
+- `templates/`
+- `docs/README.md`
+- `asset-manifest.json`
+
+## Why this exists
+
+- skills can rely on a standard installed asset root
+- helper paths can repair missing support assets automatically
+- packaged references do not depend on a source checkout
+- the product can use relevant packaged files without path guessing
+
+## Contract
+
+When Meta-Architect needs packaged support files, prefer the installed support bundle first.
+
+Examples:
+- MCP starter files -> `meta-architect-sdk/mcp/`
+- sprint references -> `meta-architect-sdk/sprint/`
+- Codex prompt assets -> `meta-architect-sdk/prompts/`
+- helper scripts -> `meta-architect-sdk/scripts/`
+- plugin metadata -> `meta-architect-sdk/plugins/meta-architect/`
+- templates -> `meta-architect-sdk/templates/`
+
+The in-session skill flow is still primary. This bundle only standardizes packaged asset access.