docs(proxy): correct --code-aware default to disabled#1710
Merged
chopratejas merged 1 commit intoJul 2, 2026
Conversation
The wiki proxy flag table claimed --code-aware defaults to true, but the CLI deliberately defaults it off (headroom/cli/proxy.py resolves the flag to disabled unless --code-aware or HEADROOM_CODE_AWARE_ENABLED is set). Align the table with the actual behavior and the other docs (docs/content/docs/proxy.mdx, wiki/cli.md), and collapse the self-contradictory --no-code-aware row into the paired-flag entry. Fixes headroomlabs-ai#1700 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
PR governanceThis PR follows the template and is marked ready for human review. |
JerrettDavis
approved these changes
Jul 2, 2026
JerrettDavis
left a comment
Collaborator
There was a problem hiding this comment.
Docs review looks good. The wiki table now matches the CLI's paired --code-aware / --no-code-aware behavior and the existing docs that describe code-aware compression as disabled unless explicitly enabled.
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.
Description
The wiki proxy page (
wiki/proxy.md, which feeds the published docs site) claimed--code-awaredefaults to true. The CLI deliberately defaults it to disabled:headroom/cli/proxy.pyresolves the paired flag to off unless--code-awareis passed orHEADROOM_CODE_AWARE_ENABLEDis truthy, and the Click help text plusdocs/content/docs/proxy.mdxandwiki/cli.mdalready document it as disabled. This PR aligns the one remaining stale table row and collapses the self-contradictory separate--no-code-awarerow into a single paired-flag entry, matching the style used indocs/content/docs/proxy.mdx.Fixes #1700
Type of Change
Changes Made
wiki/proxy.md: replaced the two flag-table rows claiming--code-awaredefaulttrue/--no-code-awaredefaultfalsewith one--code-aware/--no-code-awarerow documenting the actual default (disabled), theheadroom-ai[code]requirement, and theHEADROOM_CODE_AWARE_ENABLED=1env opt-in.Testing
pytest)ruff check .)mypy headroom)Test Output
Real Behavior Proof
upstream/main(9fbd47b), Python 3.13.headroom proxy --help(via Click test runner) to confirm the CLI help says "Default: disabled"; inspectedheadroom/cli/proxy.pyflag resolution (explicit flag →HEADROOM_CODE_AWARE_ENABLED→ off);grep -rn "code.aware" wiki/ docs/to find every doc stating a default.docs/content/docs/proxy.mdx:61andwiki/cli.md:255-256already say disabled/off; onlywiki/proxy.md:77-78claimed true. After the change the table matches actual behavior.Review Readiness