Skip to content

docs: restructure README as concise entry point with docs site links#930

Open
mikewong23571 wants to merge 1 commit intovercel-labs:mainfrom
mikewong23571:pr7/slim-readme
Open

docs: restructure README as concise entry point with docs site links#930
mikewong23571 wants to merge 1 commit intovercel-labs:mainfrom
mikewong23571:pr7/slim-readme

Conversation

@mikewong23571
Copy link
Contributor

@mikewong23571 mikewong23571 commented Mar 19, 2026

Summary

  • Slim README from 1,271 lines to 142 lines
  • Docs site (agent-browser.dev) becomes the single source of truth
  • README retains: intro with value props, install snippet, quick start, options table, architecture diagram, platforms, license
  • Detailed content (commands, sessions, security, configuration, etc.) replaced with a documentation index table linking to agent-browser.dev
  • Uses providers/ terminology and URLs per maintainer feedback

Part of #774 (item 7 in the incremental PR plan)

Test plan

  • All links in documentation table resolve to correct docs pages
  • README renders correctly on GitHub
  • No content removed that isn't covered by the docs site

🤖 Generated with Claude Code

Slim README from 1271 lines to 142 lines. Detailed content now lives
in the docs site (single source of truth). README becomes a concise
entry point with install, quick start, options table, architecture,
and a documentation index linking to agent-browser.dev.

Fixes part of vercel-labs#774

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@vercel
Copy link
Contributor

vercel bot commented Mar 19, 2026

@mikewong23571 is attempting to deploy a commit to the Vercel Labs Team on Vercel.

A member of the Team first needs to authorize it.

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