Skip to content

Rewrite README for alpha development - #201

Merged
bigboateng merged 2 commits into
mainfrom
docs/alpha-readme
Aug 12, 2026
Merged

Rewrite README for alpha development#201
bigboateng merged 2 commits into
mainfrom
docs/alpha-readme

Conversation

@bigboateng

@bigboateng bigboateng commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • mark Boatstack clearly as alpha software under active development
  • replace the README with a practical install and first-use path
  • inventory the shipped Kernel, Control Program, authority, recovery, runtime, host, SDK, extension, and analysis surfaces
  • separate current Flow internals from the unfinished Flow authoring experience
  • add the required append-only release note

Verification

  • python3 -m unittest discover -s .github/tests -p 'test_*.py'
  • python3 .github/scripts/release_notes.py validate --repo .
  • python3 .github/scripts/release_notes.py preflight --repo . --base-branch main
  • git diff --check

Boundary-conformance impact: none. This changes public documentation only.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codex automated review

Verdict: patch is incorrect
Confidence: 0.99

The documentation rewrite causes a deterministic repository-contract CI failure and gives incorrect invocation syntax to Cursor users. Model-level verification is not recommended because this change is documentation-only and both defects are directly established.

Comment thread README.md
Comment thread README.md

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codex automated review

Verdict: patch is correct
Confidence: 0.99

The documentation-only changes match the repository’s CLI commands, installer behavior, transition count, paths, and generated host-driver contracts. No actionable defect was established. Model-level verification is not recommended for this change.

@bigboateng
bigboateng enabled auto-merge (squash) August 12, 2026 07:45
@bigboateng
bigboateng merged commit 7c9f644 into main Aug 12, 2026
16 checks passed
@bigboateng
bigboateng deleted the docs/alpha-readme branch August 12, 2026 07:45
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