Skip to content

doc[notask]: enhance README and add Keet launcher - #3909

Open
BrunoCampana wants to merge 14 commits into
mainfrom
docs/enhance-readme
Open

doc[notask]: enhance README and add Keet launcher#3909
BrunoCampana wants to merge 14 commits into
mainfrom
docs/enhance-readme

Conversation

@BrunoCampana

@BrunoCampana BrunoCampana commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

What problem does this PR solve?

  • Make the README a concise, skimmable entry point that communicates QVAC's value and guides visitors to deeper documentation.
  • Provide a reliable way to join the QVAC Keet room from GitHub and the documentation site, where direct keet:// links are sanitized or unsupported.

How does it solve it?

  • Refine the hero typography and copy, consolidate the badge presentation, and add the Keet entry to the README.
  • Add a standalone /keet/ launcher with automatic deeplink handling and fallback download, QR-code, copy-link, and manual-open controls.
  • Share the Keet room data and mascot between the launcher and the existing docs modal.
  • Add the same manual “Open in Keet” action to the modal and keep the local Keet badge asset independent of a long Shields.io data URI.

Preview

Check how the README will look like:
https://github.com/tetherto/qvac/tree/docs/enhance-readme

Check how the keet launcher will look like:
https://qvac-docs-staging-test-1-di1kk.kinsta.page/keet/

- Rework the hero, badges, quickstarts, and HTTP server walkthrough for a faster first impression.\n- Move the complete branding asset catalog into docs/branding/BADGES.md while keeping the main README skimmable.\n- Add clearer Python, JavaScript, and tool-connection guidance with links to deeper documentation.
- Add a local Keet badge asset and link it from the README.\n- Add a standalone /keet/ launcher with deeplink fallback, QR code, and download controls.\n- Share the Keet room data and mascot between the launcher and existing modal.\n- Keep the launcher path free of the deprecated community segment.
- Add the same Open in Keet action used by the standalone launcher page.\n- Keep the fallback modal visible when the browser cannot handle the Keet deeplink.\n- Reuse the existing room link and match the launcher button styling.
- Clarify the hero heading by separating the local AI product from its SDK and model provider roles.\n- Simplify the supporting tagline to cover both application development and local model serving.
@github-actions

Copy link
Copy Markdown
Contributor

Review Status

Current Status: ❌ PENDING
Approvals so far: none

Pending reviews: Needs 1 Management or Team Lead, and 1 more from Management, Team Lead, or Member.

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