docs: state repo scope in README (minimal, one app per mechanism) - #38
Open
rickstaa wants to merge 1 commit into
Open
docs: state repo scope in README (minimal, one app per mechanism)#38rickstaa wants to merge 1 commit into
rickstaa wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull request overview
Aligns the repository documentation with the updated repo description and removes stale references to the old GitHub repository name by updating links across the project READMEs.
Changes:
- Updates the root README intro to mention that payment flows directly on the network and clarifies how each example differs (transport/registration/pricing).
- Replaces remaining
live-runner-example-appsGitHub links withapp-exampleslinks across docs. - Updates per-example READMEs (
hello-world,tiles,vllm) to point issue references at the renamed repository.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates intro wording and fixes issue/compare links to the renamed repo. |
| CONTRIBUTING.md | Updates the “Open an issue” link to livepeer/app-examples. |
| hello-world/README.md | Updates issue link in the NOTE block to the renamed repo. |
| tiles/README.md | Updates issue link in the NOTE block to the renamed repo. |
| vllm/README.md | Updates issue link in the NOTE block to the renamed repo. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Say what the repo is upfront: minimal example apps, one small app per transport, registration, and pricing mode, with payment flowing directly on the network — mirroring the GitHub repo description. Rename the Communication schemas section to Transports (the term the rest of the README and the description already use), state explicitly that the repo stays minimal and full-featured apps belong under External examples, and sweep the remaining pre-rename live-runner-example-apps links to app-examples. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
rickstaa
force-pushed
the
rs/readme-align-description
branch
from
July 28, 2026 12:26
1c5d2d5 to
6afe695
Compare
rickstaa
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
live-runner-example-appsname toapp-examples(root README, CONTRIBUTING, hello-world/tiles/vllm READMEs).Why
The repo description was rewritten to lead with coverage and the payment loop, but the README never stated the curation policy — a reader couldn't tell whether this repo intends to collect every app ever built or stay small. Stating the scope draws a clear boundary: this repo teaches each mechanism in the smallest possible app; complete, full-featured apps are linked under External examples.
🤖 Generated with Claude Code