Skip to content

docs: replace nonexistent pip extras and stale serve --offline flag#8548

Merged
scarmani merged 2 commits into
mainfrom
structex/misc-docs-extras
Jun 22, 2026
Merged

docs: replace nonexistent pip extras and stale serve --offline flag#8548
scarmani merged 2 commits into
mainfrom
structex/misc-docs-extras

Conversation

@scarmani

Copy link
Copy Markdown
Collaborator

Source

Docs-hygiene sweep carried from the p2-contradictions handoff (library/tech-debt.md). Live install docs instructed pip install aragora[<extra>] for extras absent from pyproject.toml [project.optional-dependencies]; p2-contradictions fixed only the research extra (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 (stale aragora serve --offline should be --demo).

Behavior

  • Authoritative extras re-enumerated at HEAD: all, blockchain, connectors, dev, enterprise, experimental, gateway, test.
  • Every live instructional surface (README.md, INSTALL.md, DEVELOPMENT.md, CONTRIBUTING.md, docs/**, docs-site/docs/**, excluding docs/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).
  • Stale aragora serve --offline prose replaced with the correct --demo flag (verified via python3 -m aragora.cli.main serve --help).
  • docs/guides/TROUBLESHOOTING.md recovery section now includes the pip install -e . console-script note, consistent with docs/ops/RUNBOOK.md.
  • docs-site mirrors regenerated via scripts/doc_stats.py --write + docs-site/scripts/sync-docs.js. No functional/code changes.

Validation

  • rg sweep over live surfaces (excluding docs/archive/**): zero aragora 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 passed
  • AWS_* neutralized make test-smoke: Smoke tests passed!
  • docs-build drift recheck (doc_stats.py --write + sync-docs.js, then git diff --quiet): clean.

Risks

Docs-only; no functional/code changes. The docs/STATUS.md mirror (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-line aragora[rlm] -> base-install change.

Tier 0 (docs-only).

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>
@scarmani scarmani marked this pull request as ready for review June 22, 2026 17:51
@scarmani scarmani requested a review from an0mium as a code owner June 22, 2026 17:51
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>
@scarmani

Copy link
Copy Markdown
Collaborator Author

Grok independent model review

Reviewer: grok (xai) — independent adversarial model review via the Aragora Grok reviewer, grounded on the exact PR head.
Head: d05d429 (d05d429), committed 2026-06-22T20:28:07Z.
PR: #8548.
Model family: grok

Verdict: PASS

No findings.

dogfood: yes

@scarmani

Copy link
Copy Markdown
Collaborator Author

Claude independent model review

Reviewer: claude (anthropic) — independent adversarial model review via the Aragora Claude reviewer, grounded on the exact PR head.
Head: d05d429 (d05d429), committed 2026-06-22T20:28:07Z.
PR: #8548.
Model family: claude

Verdict: PASS

Confirmed accurate (high-signal checks):

  • Extras listpyproject.toml defines exactly test, gateway, blockchain, enterprise, connectors, experimental, dev, all; the PR's enumeration matches, and the removed names (postgres, monitoring, observability, redis, documents, broadcast*, ml, sso, rlm, gauntlet, mcp, langchain, research, persistence) are genuinely not real extras — pip install aragora[<those>] would no-op/warn today, so the rewrites are strict corrections.
  • [postgres][enterprise] and [sso][enterprise]enterprise = asyncpg, python3-saml, supabase, so both DB-driver and SAML deps are actually delivered. init_postgres_db.py needs only asyncpg (alembic is opt-in via --alembic), so no migration-tooling regression.
  • serve --offlineserve --demoserve_parser defines --demo (parser.py:1728) and has no --offline; cmd_serve sets ARAGORA_OFFLINE/ARAGORA_DEMO_MODE (server.py:20-22). Correct fix.
  • Docker VARIANT table — matches deploy/Dockerfile (default full, minimal/postgres branches) and the full branch's persistence,redis,monitoring,observability,postgres,rlm group set in ci_install_project.sh.
  • RLM split (base = compression fallback, pip install rlm = TRUE RLM) matches the HAS_OFFICIAL_RLM design.

[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 ml: ~2GB and broadcast-xtts: ~500MB, i.e. fictional extra names used as labels. Harmless (not install commands) but a leftover inconsistency adjacent to the edited hunk; suggest relabeling to the package names used elsewhere in the PR.

dogfood: yes

@scarmani scarmani merged commit 1b88d3c into main Jun 22, 2026
39 of 44 checks passed
@scarmani scarmani deleted the structex/misc-docs-extras branch June 22, 2026 20:53
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