Skip to content

docs(readme): highlight hosted service and MCP setup - #1008

Merged
jiashuoz merged 2 commits into
mainfrom
docs/hosted-readme-cta
Sep 7, 2026
Merged

docs(readme): highlight hosted service and MCP setup#1008
jiashuoz merged 2 commits into
mainfrom
docs/hosted-readme-cta

Conversation

@jiashuoz

@jiashuoz jiashuoz commented Sep 7, 2026

Copy link
Copy Markdown
Member

Summary

GitHub visitors can miss that e2a offers managed hosting. Put a Token Canopy green hosted-service CTA and text fallback directly below the headline, followed by a copyable one-line prompt that connects a coding agent to the hosted MCP server and guides browser OAuth sign-in.

Move hosted/self-hosted starting paths ahead of installation, keep existing quickstart and use-it anchors, and move badges and the full compatibility notice below getting started. The button uses canopy green with warm cream text, and the wordmarks use matching green accents for light and dark backgrounds. No runtime or API changes.

Test plan

  • scripts/check-repository-text-integrity.sh (including four Python example tests)
  • git diff --check
  • Inspect the branch README rendered on GitHub: green SVG, fallback link, MCP prompt and GitHub copy control display correctly
  • Verify the endpoint and browser OAuth instructions against the live public setup guide

Runtime suites do not apply to this README/SVG-only change. Independent review passed with no findings. Adversarial review found no blockers; its optional suggestion to embed the setup-guide URL in the prompt is deferred to keep the one-line prompt concise, with the guide linked directly below. All internal anchors resolve; SVG XML and button text contrast were checked.

Color follow-up: SVG XML, whitespace, text-integrity checks, and live GitHub rendering passed. CTA text contrast is 9.49:1; light/dark wordmark accent contrast is 11.15:1 / 5.62:1 on the corresponding GitHub backgrounds. Independent review passed.

Signed-off-by: Josh Zhang <39790535+jiashuoz@users.noreply.github.com>
Signed-off-by: Josh Zhang <39790535+jiashuoz@users.noreply.github.com>
@jiashuoz
jiashuoz merged commit 1999feb into main Sep 7, 2026
42 of 43 checks passed
@jiashuoz
jiashuoz deleted the docs/hosted-readme-cta branch September 7, 2026 03:56
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