Skip to content

docs: refresh README to house style - #11

Draft
ashpreetbedi wants to merge 1 commit into
mainfrom
docs/refresh-2026-07-07
Draft

docs: refresh README to house style#11
ashpreetbedi wants to merge 1 commit into
mainfrom
docs/refresh-2026-07-07

Conversation

@ashpreetbedi

Copy link
Copy Markdown
Contributor

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

  • New "How it works" table: role-gated single agent, CRM schema, knowledge base, skills, workflows/schedules, double-gated external actions.
  • Quick start verified against compose.yaml (two containers, dev hot-reload, localhost:8000/docs).
  • Interfaces trimmed to what's actually wired: AgentOS web UI, built-in MCP server (enable_mcp_server=True, one use_context tool), Slack. Removed the long per-client manual MCP setup blocks (claude/codex CLI commands, Claude Desktop and Cursor JSON) — scripts/connect.py plus docs/MCP.md supersede them.
  • Deploy section condensed; explicitly calls out the single-replica scheduler (railway.json numReplicas: 1, INTERNAL_SERVICE_TOKEN, docs/SCALING.md) and that AgentOS refuses to serve traffic in prd without JWT_VERIFICATION_KEY.
  • Configuration table trimmed to the high-signal vars (added OWNER_TIMEZONE, which the old table omitted); example.env stays the exhaustive reference.
  • Evals section now notes the local venv prerequisite (./scripts/venv_setup.sh).
  • Removed inline step-by-step walkthroughs duplicated in docs/ (knowledge→Git PAT walkthrough, Slack setup steps, codebase tour → AGENTS.md).

Other docs

  • docs/MCP.md and docs/SLACK.md linked to README anchors that no longer exist (#connect-production-context-mcp-server, #agentos-ui, #run-in-production); repointed to #interfaces / #deploy.

Non-doc notes for the reviewer (no code changed)

  • Orthogonal to the open agno bump PR (chore: update context — agno 2.6.16→2.7.0a6, hygiene audit #10, chore/update-2026-07-07): README no longer states an agno version, so it stays accurate across the 2.6.16→2.7 bump. The JWT-at-prod-boot behavior is true on the current pin already.
  • pyproject.toml comment says "agno 2.6.x targets the fastmcp 2.x API" for the fastmcp<3 pin — worth rechecking during the 2.7 bump, not here.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@ashpreetbedi

Copy link
Copy Markdown
Contributor Author

🤖 Automated re-review

No blocking issues found.

Re-checked the full diff for correctness, reuse/simplification, and efficiency regressions; nothing blocking surfaced.

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