Skip to content

Refocus the Web README on public surfaces - #36

Merged
konojunya merged 2 commits into
mainfrom
agent/reader-first-readme
Sep 6, 2026
Merged

Refocus the Web README on public surfaces#36
konojunya merged 2 commits into
mainfrom
agent/reader-first-readme

Conversation

@konojunya

@konojunya konojunya commented Sep 6, 2026

Copy link
Copy Markdown
Member

Background

The README exposed the correct public URLs but placed Docs generation, pinning, metadata, and release operations before the Playground's capabilities and repository role.

Implementation Approach

  • Lead with the live Playground and four-language documentation surfaces.
  • Summarize the workflows available to diagram authors and coding agents.
  • Keep a compact local start and command table.
  • Explain how Docs, specification examples, Engine, and Cloudflare fit together.
  • Move pin synchronization, example corpus, generated metadata, and deployment procedures to CONTRIBUTING.
  • Consume the merged Docs revision that adds CLI health and shell setup to all four Getting Started pages.

Testing Approach

  • npm run format:check
  • npm run lint
  • npm test
  • npm run build
  • npm run cloudflare:check
  • Validated all 60 documentation pages and nine canonical runtime examples.
  • Verified the Docs manifest at commit e9847c68865027dd51be9ec18df263d6a9ccbcd1.

Review Perspectives / Points of Concern

Please verify that contributor procedures remain discoverable without obscuring the public product surfaces, and that the README does not suggest checked-in example SVGs.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 6, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
stack-web 5b23fb8 Commit Preview URL

Branch Preview URL
Sep 06 2026, 03:57 AM

@konojunya
konojunya merged commit 7d76099 into main Sep 6, 2026
2 checks passed
@konojunya
konojunya deleted the agent/reader-first-readme branch September 6, 2026 04:00
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