docs: mention uvx quickstart and playground in README and getting-started#127
Conversation
…rted - README and docs/index.md highlight the `uvx tryke test` one-liner and link to playground.tryke.dev. - CONTRIBUTING.md documents how to run and deploy the playground.
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates documentation to make it easier for new users and contributors to discover the fastest way to try tryke (via uvx) and the browser playground, while also documenting playground development/deployment steps.
Changes:
- Add
uvx tryke testquickstart callout to the README and docs landing page. - Link to the hosted playground (
playground.tryke.dev) from both docs entry points. - Document local playground dev and manual Cloudflare Pages deploy flow in CONTRIBUTING.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/index.md | Adds an uvx quickstart snippet and playground link to the “Getting started” section. |
| README.md | Replaces the generic doc pointer with uvx quickstart + playground link + updated docs sentence. |
| CONTRIBUTING.md | Adds a “playground” section with local dev commands and Cloudflare Pages deployment instructions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## playground | ||
|
|
||
| the browser playground lives in `playground/`. to run it locally: |
| bun run dev | ||
| ``` | ||
|
|
||
| to deploy manually to Cloudflare Pages: |
| this creates a preview deployment at a unique URL (e.g. | ||
| `<hash>.tryke-playground.pages.dev`). to deploy straight to production, add |
| pushes to `main` that touch the playground or WASM crates deploy automatically | ||
| to production via the `playground` GitHub Actions workflow. |
| this creates a preview deployment at a unique URL (e.g. | ||
| `<hash>.tryke-playground.pages.dev`). to deploy straight to production, add |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5da15fdf5c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ## playground | ||
|
|
||
| the browser playground lives in `playground/`. to run it locally: |
There was a problem hiding this comment.
For contributors on this revision, these new instructions cannot be followed because the repository does not contain a playground/ directory, and .github/workflows also has no playground workflow for the later auto-deploy claim. I checked repo-wide for playground/wasm paths and the GitHub workflows, so this section appears to document assets from the split-out playground work before they have landed.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 273ddf1ddd
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| Write a test. | ||
| ```bash | ||
| uvx tryke |
There was a problem hiding this comment.
For first-time users copying this README quickstart, uvx tryke does not run the tests once: the CLI treats a bare invocation as the default watch command (Commands::default_watch() sets watch: true and now: false), and the watch option docs say it starts idle until a file change unless --now is passed. This makes the “get started quickly” command appear to hang rather than execute the example; the docs page already uses uvx tryke test, which matches the intended one-shot run.
Useful? React with 👍 / 👎.
Context
Split out the documentation-only changes from #126 so they can land independently of the playground/WASM work.
Changes
README.mdanddocs/index.md: highlight theuvx tryke testquickstart and link toplayground.tryke.dev.CONTRIBUTING.md: add a "playground" section covering local dev and manual Cloudflare Pages deploys.Test plan
Generated by Claude Code