Repository navigation
docs(readme): redesign README with real Web workbench media - #918
Merged
Merged
Conversation
- New hero (light/dark via <picture>), demo recording, feature grid, v1.2.0 highlights, screenshot tour and architecture diagram - Screenshots and recording are captured from the real OpenPI Web workbench against a demo repository (scripted local provider) - Same structure for README.zh-CN.md; reference sections unchanged, Defaults table folded into <details> - Media lives in docs/assets/readme/ so it is not shipped in the npm package
github-actions
Bot
added
documentation
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.
Summary
Redesigns
README.mdandREADME.zh-CN.mdaround real OpenPI Web workbench media.Structure
<picture>, dark/light), tagline, existing badges, link row (Quick start · Tour · Website · Reference · Releases · 中文), disclaimer, animated demo./weband/openpi-setup.<details>. The config-contract marker and the "Pi0.99.1or newer" text are unchanged.Media honesty
All screenshots and the animated demo come from the real OpenPI Web host, and every tool call (read, bash, edit, subagents, workflow,
node --test) really ran against a demo repo. Model replies come from a scripted local OpenAI-compatible provider so the capture is reproducible, and the README caption says so. The only generated image is the abstract background art behind the hero. No UI was generated.New assets (
docs/assets/readme/, ~1.6 MB, not in npmfiles)Removed (no longer referenced anywhere in the repo)
assets/openpi-launch-card-v1.webpassets/readme-hero.svgassets/readme-hero-mobile.svgThese stay because they are still referenced:
openpi-product-hero-v2.webp(site og:image),readme-runtime*.svg(USAGE.md) andopenpi-package.png(package.json and the contract test).Checks
bun run checkandbun run testpass locally. Noweb/distchanges.