docs: refresh README to house style - #11
Draft
ashpreetbedi wants to merge 1 commit into
Draft
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Author
|
🤖 Automated re-review No blocking issues found. Re-checked the full diff for correctness, reuse/simplification, and efficiency regressions; nothing blocking surfaced. |
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
Docs-only rewrite of README.md to the family house style (tagline → intro → How it works → Quick start → Interfaces → Deploy → Configuration → Evals → Links), ~390 lines → ~120. Every command was verified against the current tree (compose.yaml, scripts/, evals/main.py, railway.json, example.env, app/main.py).
README changes
enable_mcp_server=True, oneuse_contexttool), Slack. Removed the long per-client manual MCP setup blocks (claude/codex CLI commands, Claude Desktop and Cursor JSON) —scripts/connect.pyplus docs/MCP.md supersede them.numReplicas: 1, INTERNAL_SERVICE_TOKEN, docs/SCALING.md) and that AgentOS refuses to serve traffic in prd withoutJWT_VERIFICATION_KEY.OWNER_TIMEZONE, which the old table omitted); example.env stays the exhaustive reference../scripts/venv_setup.sh).Other docs
#connect-production-context-mcp-server,#agentos-ui,#run-in-production); repointed to#interfaces/#deploy.Non-doc notes for the reviewer (no code changed)
fastmcp<3pin — worth rechecking during the 2.7 bump, not here.🤖 Generated with Claude Code