Skip to content

doc: improve README first-reader flow - #211

Open
ejgallego wants to merge 4 commits into
mainfrom
codex/docs-status-content-review
Open

doc: improve README first-reader flow#211
ejgallego wants to merge 4 commits into
mainfrom
codex/docs-status-content-review

Conversation

@ejgallego

@ejgallego ejgallego commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

This PR improves the public documentation path for a first-time Beam reader while keeping current behavior separate from exact setup and protocol contracts.

  • Explain the runAt workflow before the architecture diagram while keeping that visual overview prominent.
  • Use preview language consistently and move detailed feedback and checkpoint guidance out of the introductory flow.
  • Turn docs/STATUS.md into a concise current scope, contract, limitation, and direction summary.
  • Keep maintainer guidance aligned and point Rocq installation back to the canonical setup guide.

@ejgallego
ejgallego force-pushed the codex/docs-status-content-review branch from 4a570f7 to 7e86062 Compare August 25, 2026 11:40
@ejgallego
ejgallego marked this pull request as ready for review August 25, 2026 12:17
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