Skip to content

docs: refresh scout README to house style - #25

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

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

Conversation

@ashpreetbedi

Copy link
Copy Markdown
Contributor

What changed (docs only)

Rewrote README.md to the family house style — tight, skimmable, every command verified against the current code (compose.yaml, scripts/, app/main.py, scout/, evals/, example.env):

  • New structure: tagline → intro → How it works → Quick start → Interfaces → Deploy → Configuration → Evals → Source/links.
  • How it works: consolidated the agent + context-provider explanation and the provider table (verified against scout/contexts.py); dropped the YC RFS framing.
  • Quick start: unchanged compose path, verified against compose.yaml (scout-db + scout-api, port 8000, hot reload).
  • Interfaces: now covers all three wired interfaces — AgentOS web UI, Slack (both env vars required for the interface; token alone gives the read-only context), and the terminal CLI (python -m scout / python -m scout contexts, verified against scout/__main__.py). Kept both demo videos.
  • Deploy: condensed the 7-step Railway walkthrough into a pointer with the two must-know facts: JWT_VERIFICATION_KEY required at prod boot (agno 2.7 / authorization=runtime_env == "prd" in app/main.py), and the single-replica scheduler caveat. Removed the hardcoded app/main.py:67 line reference (brittle).
  • Configuration: env-var table sourced from example.env (no secret values).
  • Evals: commands verified against evals/__main__.py (wiring, default behavioral, --case, judges).
  • Removed the stale What's next section (referenced unmerged feat/slack-interface work) and other prose drift.

CONTRIBUTING.md does not exist; docs/*.md checked and found current (WIKI_GIT.md already documents the GitBackend auto-detect) — no changes needed there.

Non-doc issues spotted (NOT changed in this PR)

  1. Scheduler vs. replicas: railway.json sets numReplicas: 2 while app/main.py enables scheduler=True. The AgentOS scheduler assumes a single replica — with 2 replicas scheduled tasks can fire twice. README now documents the caveat, but the config itself may want numReplicas: 1 (or a leader-election story).
  2. Stale comment in example.env (wiki section, ~line 66): says "Then update _create_knowledge_wiki() in scout/contexts.py" — obsolete since the GitBackend auto-detect landed (89090b5). Left untouched to keep this PR strictly docs; trivially fixable in the open bump PR or a follow-up.
  3. requirements.txt pins agno==2.6.4; the README's "agno 2.7 requires JWT_VERIFICATION_KEY at prod boot" claim anticipates the open chore/update-* bump PR. Worth double-checking the wording lands after/with that bump.

🤖 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

Issues found:

  • [low] README.md:67 — README attributes the prod-boot JWT requirement to "agno 2.7", but the repo pins agno==2.6.4. README.md:67 says "agno 2.7 refuses to serve in prod without a JWT_VERIFICATION_KEY." while requirements.txt:3 pins agno==2.6.4 at this commit. The PR is docs-only, so no bump accompanies it. The behavior is actually driven by the version-independent app/main.py:67 authorization=runtime_env == "prd". A reader on 2.6.4 sees a contradiction.

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