docs: replace nonexistent pip extras and stale serve --offline flag#8548
Conversation
Sweep live install docs so no instruction references a pip extra absent from pyproject.toml [project.optional-dependencies] (authoritative set: all, blockchain, connectors, dev, enterprise, experimental, gateway, test). Nonexistent extras (rlm, gauntlet, mcp, langchain, broadcast*, documents, monitoring, observability, postgres, redis, persistence, ml, sso) are replaced with a real extra (enterprise/gateway/all), the plain base install, or direct package installs. Replace stale `aragora serve --offline` prose with the correct `--demo` flag (verified via `aragora serve --help`). Add the `pip install -e .` console-script note to docs/guides/TROUBLESHOOTING.md recovery section, consistent with docs/ops/RUNBOOK.md. Regenerate docs-site mirrors via sync-docs.js. Excludes docs/archive and dated history. Docs-only; no code changes. Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Address repo-grounded review of the extras sweep: where install commands were swapped to real extras/base, adjacent 'Adds:/Includes' prose still described the old fictional extras. Point TRUE RLM at the official `rlm` package (base install only ships the compression fallback), fix UPGRADE_ROADMAP observability (otel/prometheus are not base deps) and enterprise (asyncpg/python3-saml/ supabase, not sqlalchemy/alembic), align DEPLOYMENT build-variants with the real deploy/Dockerfile (ARG VARIANT + ci_install_project.sh), relabel DEPENDENCIES Profile 2 as the FastAPI gateway, and standardize basic TTS on edge-tts/pydub. Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Claude independent model reviewReviewer: claude (anthropic) — independent adversarial model review via the Aragora Claude reviewer, grounded on the exact PR head. Verdict: PASS Confirmed accurate (high-signal checks):
[P3] docs/reference/DEPENDENCIES.md & docs-site/docs/contributing/dependencies.md, "Large Downloads" section — the changed intro line now reads "ML models and premium TTS packages are large downloads", but the bullets directly under it still label them dogfood: yes |
Source
Docs-hygiene sweep carried from the p2-contradictions handoff (
library/tech-debt.md). Live install docs instructedpip install aragora[<extra>]for extras absent frompyproject.toml [project.optional-dependencies]; p2-contradictions fixed only theresearchextra (VAL-P2-003). This PR also carries the p2-quickstart-canonical / PR #8482 reviewer note (TROUBLESHOOTING recovery lacked the console-script one-liner) and the p2-docs scrutiny note (stalearagora serve --offlineshould be--demo).Behavior
all, blockchain, connectors, dev, enterprise, experimental, gateway, test.README.md,INSTALL.md,DEVELOPMENT.md,CONTRIBUTING.md,docs/**,docs-site/docs/**, excludingdocs/archive/**+ dated history) no longer instructs installing a nonexistent extra. Replacements point to a real extra (enterprise/gateway/all), the plain base install, or direct package installs (e.g.pip install prometheus-client sentry-sdk,pip install edge-tts pydub).aragora serve --offlineprose replaced with the correct--demoflag (verified viapython3 -m aragora.cli.main serve --help).docs/guides/TROUBLESHOOTING.mdrecovery section now includes thepip install -e .console-script note, consistent withdocs/ops/RUNBOOK.md.scripts/doc_stats.py --write+docs-site/scripts/sync-docs.js. No functional/code changes.Validation
rgsweep over live surfaces (excludingdocs/archive/**): zeroaragora serve --offline; zero nonexistent-extra install refs.make lint:All checks passed!python3 -m pytest tests/scripts/test_docs_site_sync_links.py -q:5 passedAWS_*neutralizedmake test-smoke:Smoke tests passed!doc_stats.py --write+sync-docs.js, thengit diff --quiet): clean.Risks
Docs-only; no functional/code changes. The
docs/STATUS.mdmirror (docs-site/docs/contributing/status.md) is also touched by stale, already-CONFLICTING PRs #8460/#8461 (which only edit that mirror + archived files); the overlap here is a single-linearagora[rlm]-> base-install change.Tier 0 (docs-only).