Conversation
The Compression Guide's caveman output mode and output-styles passages described behavior the code does not have. Correct them against the current sources: - When to use: the legacy mode is switched by cavemanOutputMode.enabled, which replaces the routing-combo config.auto.outputMode example. A compression combo's Output Mode toggle and the omniroute_set_compression_engine MCP tool's outputMode argument set the same switch. - Back-compat: the mapping to terse-prose applies while outputStyles is empty. The block starts with the [OmniRoute Output Styles] marker; the text matches the legacy injector in en, pt-BR, es, de, fr, it, ru, id and vi, carries one extra space before the boundaries clause in ja and zh, and is English for hu, which terse-prose does not translate. - Boundaries: SHARED_BOUNDARIES keeps code blocks, file paths, commands, errors and URLs exact; terse-prose and terse-cjk add identifiers, and less-code and ponytail add the SAFETY_BOUNDARIES clause. - Auto-Clarity: the content bypass runs while the Auto-Clarity Bypass toggle is on (the default) and is skipped when it is off. The toggle is on the Caveman page's Output Mode card. - How to enable: the dashboard path uses the sidebar labels (Compression Context, Compression Settings).
An accuracy review of the previous commit against the sources found four sentences that were imprecise: - The legacy switch takes effect only while compression itself is on (the master `enabled` flag, off by default), and a non-empty outputStyles selection overrides it. The example now sets both flags, and How to enable states the master-switch requirement for all styles. - "The Terse prose output style injects the same text" read as a comparison with the legacy injector; it now says the same block. - The safety clause less-code and ponytail add can be its translation. - Turning the Auto-Clarity Bypass toggle off skips the keyword check; it does not force injection, which other conditions can still prevent.
…pression-guide-output-mode
This was referenced Oct 5, 2026
Contributor
Author
|
PR #15591 fixes the hu/ja/zh drift that the new guide paragraph here documents: Hungarian gets its own terse-prose text (no more English fallback), and the extra space before the boundary sentence is gone for ja/zh, including terse-cjk and multi-style selections. The paragraph and changelog line added in this PR describe the pre-fix behavior, so whichever of the two PRs lands second needs to update that wording. Cross-noted in #15591's body. |
4 tasks done
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Corrects the caveman output mode and output-styles passages in
docs/compression/COMPRESSION_GUIDE.mdagainstopen-sse/services/compression/outputMode.ts,open-sse/services/compression/outputStyles/{apply,backCompat,catalog}.tsandopen-sse/handlers/chatCore.ts.When to use: the guide showed a routing-combo
config.auto.outputMode: "caveman"setting. The only.outputModereads insrc/andopen-sse/are the compression combo's boolean (applyCompressionComboConfig()inopen-sse/handlers/chatCore.ts,src/lib/db/compressionCombos.ts:16) and theomniroute_set_compression_engineMCP tool's boolean argument (open-sse/mcp-server/tools/compressionTools.ts:464). The section now showscavemanOutputMode.enabledtogether with the masterenabledswitch it depends on (off by default pertypes.ts:421-422, checked inchatCore.tsbeforeresolveOutputStyleSelection()), names those two switches, and notes that a non-emptyoutputStylesselection takes precedence (backCompat.ts:21-23).Back-compat: the guide said the mapping to
terse-proseis byte-identical to the old injection in every legacy language. Running the legacyapplyCavemanOutputMode()side by side with the liveresolveOutputStyleSelection()→applyOutputStyles()path for all 12 legacy languages at all 3 levels shows:[OmniRoute Caveman Output Mode]vs[OmniRoute Output Styles]);apply.ts:167joins the instruction and the boundary block with a space; those two legacy texts have none);hugets the English text, becauseCAVEMAN_INSTRUCTION_BY_LANGUAGEhashu(outputMode.ts:42-46) and theterse-prosei18n map (catalog.ts:52-63) leaves it out. A Hungarian user message resolves tohuthroughresolveOutputStyleLanguage(), so this is reachable.The sentence now states that, and that the mapping applies while
outputStylesis empty (backCompat.ts:21-27).Boundaries:
SHARED_BOUNDARIES(outputMode.ts:28-29) lists code blocks, file paths, commands, errors and URLs; identifiers come from theterse-proseandterse-cjklevel texts. The "appends the boundaries clause once" sentence also gains theSAFETY_BOUNDARIESclause thatless-codeandponytailadd (apply.ts:129-139, from fix(compression): honor per-style boundaries and add the ponytail safety carve-out #13938).Auto-Clarity: the guide said the content bypass runs whatever the Auto-Clarity Bypass toggle is set to. The bypass runs while the toggle is on (
apply.ts:206; on by default pertypes.ts:466), and turning it off skips the keyword check (from fix(compression): honor the Auto-Clarity toggle on the output-styles path #14551). "How to enable" now points to the toggle's home, the Caveman page's Output Mode card (/dashboard/context/caveman,CavemanContextPageClient.tsx:249-263), and uses the sidebar labels for the Compression Settings page (sections.ts:91-120).Related Issues
Validation
npm run check:docs-allpasses, and so does each of its gates run on its own (check:docs-sync,check:docs-frontmatter,check:docs-counts,check:env-doc-sync,check:deprecated-versions,check:doc-links,check:fabricated-docs) pluscheck:docs-symbols. All of them also pass on the base tip before the edit.npm run lint(docs-only change)release/v3.8.52at 5282351, merged into this branch);check:docs-allrerun afterward and passesresolveOutputStyleLanguage(). A second claim-by-claim pass against the sources tightened four sentences (second commit).Tests Added Or Updated
Coverage Notes
docs/compression/COMPRESSION_GUIDE.mdand its changelog fragment.Reviewer Notes
i18n docs driftstep (scripts/i18n/check-translation-drift.mjs) lists this guide until that refresh. On the base tip (5282351) it already lists six other core docs:docs/architecture/QUALITY_GATES.md,docs/frameworks/ACP.md,docs/frameworks/AGENT_PROTOCOLS_GUIDE.md,docs/guides/CLI-INTEGRATIONS.md,docs/reference/API_REFERENCE.mdanddocs/reference/ENVIRONMENT.md.