Skip to content

docs: reposition the README and add alpha status - #232

Draft
ordemri wants to merge 1 commit into
release/v0.0.1-alphafrom
docs/readme-alpha-status
Draft

ordemri wants to merge 1 commit into
release/v0.0.1-alphafrom
docs/readme-alpha-status

Conversation

@ordemri

@ordemri ordemri commented Oct 15, 2026

Copy link
Copy Markdown
Collaborator

Summary

Rewrites the root README.md and adds docs/alpha-status.md. The README now leads with independent system verification, the CODE → VERIFY → SHIP position, and the real subscription-system.spec.ts example. docs/alpha-status.md records, for release 9b15ea42, what works, what is in source but unverified, what is in review, and what is roadmap, plus the commands to run the bundled example from source.

Documentation only: two Markdown files, no code, tests, config, or skills.

Scope and links

  • Closes #N: none; no linked issue yet
  • Actual publication/source branch: docs/readme-alpha-status
  • Target base: release/v0.0.1-alpha
  • Delivery phase: Post-Alpha documentation

Type of change

  • Docs / tooling only

Validation and evidence

Command Result
prettier --check README.md docs/alpha-status.md pass
relative link check on both files pass
pnpm install --frozen-lockfile, pnpm build (at release 9b15ea42) pass
blackbox --help, catalog validate, systems, skills list in e2e/ pass
blackbox onboarding start fails: command onboarding:start not found, recorded in alpha status
lint, unit tests, Docker lanes not run

Known limitations: the blackbox feature commands and typed-client APIs are in source and were not run end to end. The example needs a local package registry; there is no one-command run yet, and alpha status says so. No failing-variant demo exists.

Security impact

  • Trust boundaries affected: none
  • No secrets or private traces are included in code, logs, or artifacts

Lead with independent system verification and the subscription-system example,
document the verified source and registry run path, and record what is working,
in source, in review, and roadmap at release 9b15ea4.
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