Skip to content

docs: align env and troubleshooting docs with the code - #12404

Merged
diegosouzapw merged 2 commits into
cheaper-inference:release/v3.8.51from
pacocartones:docs/env-and-troubleshooting-drift
Sep 2, 2026
Merged

diegosouzapw merged 2 commits into
cheaper-inference:release/v3.8.51from
pacocartones:docs/env-and-troubleshooting-drift

Conversation

@pacocartones

Copy link
Copy Markdown
Contributor

Summary

Related Issues

Validation

  • Change type: Docs
  • Focused tests and category gates from the golden path: npm run check:docs-sync PASS, npm run check:env-doc-sync in sync, npm run check:doc-links PASS, npm run check:fabricated-docs -- --strict PASS, npm run check:changelog-integrity OK, prettier --check on the touched markdown
  • npm run lint — repository-wide eslint exit 0 (run with --pass-on-unpruned-suppressions; no JS/TS changed in this PR)
  • Reconciled with the current active release base release/v3.8.51; focused checks rerun afterward
  • Production-code changes include a new or updated automated test in this PR — not applicable, no production code changed
  • SonarQube is temporarily opt-in while the private project has no quota; it is not a PR gate.

Tests Added Or Updated

  • None, documentation only.

Coverage Notes

  • No changes under src/, open-sse/, electron/, or bin/; coverage unaffected.

- .env.example said OMNIROUTE_USE_TURBOPACK is a dev-only flag and that the
  production build still uses webpack; the production build reads the same
  flag and defaults to Turbopack, with 0 as the webpack escape hatch
  (scripts/build/build-next-isolated.mjs:136-145, package.json:105
  build:contributor). ENVIRONMENT.md and DOCKER_GUIDE.md already say so.
- README (Bun section) said `bun run build` auto-detects Bun and disables
  Turbopack; only `bun run dev` does that (scripts/dev/run-next.mjs:112).
  The production bundler is decided by OMNIROUTE_USE_TURBOPACK alone,
  regardless of runtime (scripts/build/build-next-isolated.mjs:136-145,
  Dockerfile.bun:44-46, tests/unit/bun-support.test.ts:105).
- docs/guides/TROUBLESHOOTING.md said OMNIROUTE_CHAT_MAX_HEAVY_IN_FLIGHT
  defaults to 1; left unset there is no request-count cap
  (src/shared/middleware/chatBodyAdmission.ts:720-724).
- docs/guides/TROUBLESHOOTING.md quoted the structural 503 message as
  "Structurally heavy chat request capacity is busy; retry shortly."; the
  code sends "Local chat admission capacity is busy for this structurally
  heavy request; upstream provider routing was not attempted. Retry
  shortly." since cheaper-inference#12223 (src/shared/middleware/chatAdmissionResponses.ts:64).

The Retry-After paragraph of the same section is left untouched because
cheaper-inference#12395 already rewrites it.

Co-authored-by: Leon Marcos <leonaniagomez@gmail.com>
@diegosouzapw
diegosouzapw merged commit eb09e89 into cheaper-inference:release/v3.8.51 Sep 2, 2026
16 checks passed
diegosouzapw added a commit that referenced this pull request Sep 2, 2026
…seline (#12434)

check-file-size was red on release/v3.8.51 with nine violations — seven source files and two test files that the 2026-09-02 merge waves grew at existing chokepoints (#12359-#12404, #11461, #11513, #12423).

The growth itself was reviewed: each file was measured and justified while validating those batches. What went wrong is the propagation — the rebaseline was computed in the throwaway combined validation worktree, and the PRs were then merged individually through their own branches, so the code landed and the caps did not. A shared-file edit made only in the validation tree reaches nothing.

This records the caps against the merged state, each entry attributed to the PR that grew it, under one _rebaseline annotation. Verified mechanically: 9 caps recorded, 0 raised beyond the file's real merged LOC, 0 unrelated entries moved — the ratchet #12411 re-tightened is intact.

Verified: check-file-size OK (135 frozen source entries across 4515 files; 39 frozen test entries across 5365), prettier clean.
muhamadgalihsaputra pushed a commit to niyatna/NiyatnaRoute that referenced this pull request Sep 27, 2026
…ence#12404)

Four documentation claims contradicted the code: .env.example called OMNIROUTE_USE_TURBOPACK dev-only and said the production build still uses webpack (it reads the same flag and defaults to Turbopack); the README's Bun section said `bun run build` auto-detects Bun and switches to Webpack (only `bun run dev` does — the production bundler is decided by the flag alone); TROUBLESHOOTING.md gave OMNIROUTE_CHAT_MAX_HEAVY_IN_FLIGHT a default of 1 when unset means no request-count cap; and it quoted the pre-cheaper-inference#12223 wording of the structural 503 chat_admission_busy message. The Retry-After bullet in the same section is deliberately untouched because cheaper-inference#12395 rewrites it.

Validated in a combined worktree with all 25 PRs of this batch boarded together: typecheck:core clean, 443/443 node-runner tests plus 14/14 vitest across every test file the batch touches, and check-changelog-integrity, check:cycles (418 files), check:provider-consistency (272 REGISTRY entries, 355 canonical providers), check:docs-counts, check:docs-sync (42 locales) and check-file-size all green.

Thanks @pacocartones.
muhamadgalihsaputra pushed a commit to niyatna/NiyatnaRoute that referenced this pull request Sep 27, 2026
…seline (cheaper-inference#12434)

check-file-size was red on release/v3.8.51 with nine violations — seven source files and two test files that the 2026-09-02 merge waves grew at existing chokepoints (cheaper-inference#12359-cheaper-inference#12404, cheaper-inference#11461, cheaper-inference#11513, cheaper-inference#12423).

The growth itself was reviewed: each file was measured and justified while validating those batches. What went wrong is the propagation — the rebaseline was computed in the throwaway combined validation worktree, and the PRs were then merged individually through their own branches, so the code landed and the caps did not. A shared-file edit made only in the validation tree reaches nothing.

This records the caps against the merged state, each entry attributed to the PR that grew it, under one _rebaseline annotation. Verified mechanically: 9 caps recorded, 0 raised beyond the file's real merged LOC, 0 unrelated entries moved — the ratchet cheaper-inference#12411 re-tightened is intact.

Verified: check-file-size OK (135 frozen source entries across 4515 files; 39 frozen test entries across 5365), prettier clean.
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.

2 participants