Commit Graph
3 Commits
Author SHA1 Message Date
Tejas ChopraandClaude Opus 5.5 4288fbd903 docs(teams): replace the 3-months-free perk with a talk-to-us pitch (#4524)
## Description

Removes the "3 months free with a 12-month plan" offer and every
headroom-perks.vercel.app link. Each place now says: not seeing the
savings you want? Headroom OSS is a framework built to show what's
possible, so it saves less; Headroom Enterprise saves more and adds more
cost savings, tokens secured, on premise deployment, deep attribution
and many more features. Teams and enterprises: talk to us at
hello@headroomlabs.ai or https://headroomlabs.ai.

## Type of Change

- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [x] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)

## Changes Made

- README banner (`.github/assets/enterprise-perk.svg`): redrawn simple,
in the `hero.svg` type scale (title 42/700, lead 14.5, eyebrow 10.5); no
animation or chips.
- README "Headroom for teams" section and docs Teams page: the
OSS-vs-Enterprise table is replaced by the pitch, feature list and
contact.
- Docs site banner (`docs/app/layout.tsx`): new copy and link; new
banner id so people who dismissed the old one see it.
- Local dashboard offer (unlicensed installs only): new copy and link;
new localStorage dismissal key (`headroom-teams-contact-dismissed`) so
people who dismissed the old offer see the new one.
- Release-notes footer (`release.yml`) and `llms.txt`: same pitch, email
and site.
- `tests/test_dashboard_teams_perk.py`: asserts the contact email
instead of the perks URL.

## Testing

- [x] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check .`)
- [ ] Type checking passes (`mypy headroom`) (no Python source changed)
- [ ] New tests added for new functionality
- [x] Manual testing performed

### Test Output

```text
$ pytest -q tests/test_dashboard_teams_perk.py -k "not route"
4 passed, 4 deselected in 0.49s
$ ruff check headroom/dashboard tests/test_dashboard_teams_perk.py
All checks passed!
```

The 4 `/dashboard` route tests fail locally with `CancelledError` at
proxy startup; they fail the same way on unmodified `main` in the same
venv, so CI is the judge for those.

## Real Behavior Proof

- Environment: macOS, Python venv of this repo, headless Chrome.
- Exact command / steps: rendered
`get_dashboard_html(licensed=False/True)` and checked the offer block;
rendered the banner with `Google Chrome --headless=new --screenshot
--window-size=900,220 file://.github/assets/enterprise-perk.svg`; `grep
-rn "headroom-perks\|3 months"` over README, docs, llms.txt, headroom/
and .github/.
- Observed result: unlicensed: offer shown, contact email present, no
perks link, new dismissal key. Licensed: offer removed. Banner renders
cleanly within 880×200 with text in the hero font. The grep finds
nothing.
- Not tested: the docs site build (`docs/`) and the release-notes footer
step (runs only on release).

## Runtime Rollout Safety

- Rollout-managed feature(s): none
- Minimum rollout channel: n/a
- Stable/default behavior changed: only the text and link of the
dashboard offer on unlicensed installs
- Kill switch / disable path: setting `HEADROOM_LICENSE` removes the
offer, as before
- Unsafe override required: no
- Qualification impact: none
- Rollback path: revert this PR

## Review Readiness

- [x] I have performed a self-review
- [x] This PR is ready for human review

## Checklist

- [x] My code follows the project's style guidelines
- [x] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [x] New and existing unit tests pass locally with my changes
- [x] I did **not** edit `CHANGELOG.md` — it is generated by
release-please from my Conventional Commit PR title (a CI guard enforces
this)

## Additional Notes

No test was added for the new dismissal key: it is browser localStorage
read by Alpine, which the Python tests do not run. Past release notes
still carry the old footer; editing them is a separate one-off.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-28 10:27:33 -07:00
3604af9bbe docs(readme): offer 3 months of Enterprise free via the perks page (#3990)
## Description

This PR promotes the Headroom Enterprise perk (3 months free with a
12-month plan) from the README, for readers who arrive on the repo. The
perk lives at headroom-perks.vercel.app.

No linked issue.

## Type of Change

- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [x] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)

## Changes Made

- **Banner:** under the intro, with the image in
`.github/assets/enterprise-perk.svg` and the link tagged
`utm_content=banner`.
- **Top nav:** a "Headroom for Teams" link.
- **"Headroom for teams" section:** an Open source vs Enterprise table,
then the offer, with email as a fallback (`utm_content=teams`).
- **Table accuracy (review fix):** the table now says what OSS already
ships. OSS has tool search on by default for Anthropic requests, and
opt-in, rule-based model routing (`HEADROOM_MODEL_ROUTES`). Enterprise
adds tool search for every model and automatic routing with a shadow
mode. The old table showed routing as unavailable in OSS.
- **Telemetry opt-out (review fix):** this text named a `--offline` flag
that does not exist (it was already wrong on `main`). The switch is
`HEADROOM_OFFLINE=1`.

## Testing

- [ ] Unit tests pass (`pytest`)
- [ ] Linting passes (`ruff check .`)
- [ ] Type checking passes (`mypy headroom`)
- [ ] New tests added for new functionality
- [x] Manual testing performed

### Test Output

```text
$ curl -s -o /dev/null -w "%{http_code}\n" "https://headroom-perks.vercel.app/?source=github&utm_source=github&utm_medium=readme&utm_content=banner"
200
$ curl -s -o /dev/null -w "%{http_code} %{content_type}\n" https://raw.githubusercontent.com/headroomlabs-ai/headroom/docs/readme-enterprise-perk/.github/assets/enterprise-perk.svg
200 image/svg+xml
$ git show origin/docs/readme-enterprise-perk:.github/assets/enterprise-perk.svg | python3 -c "import sys,xml.dom.minidom as m; m.parseString(sys.stdin.read()); print('svg parses')"
svg parses
$ headroom proxy --help | grep -i offline
(no output: there is no --offline flag)
$ pre-commit run --files README.md
check for merge conflicts....Passed   ruff format....Passed
```

## Real Behavior Proof

- Environment: macOS 26.6 (arm64), GitHub's README renderer on the
branch, the live perks page.
- Exact command / steps: the README on the branch was viewed on GitHub
(banner, nav link, Teams section and table). Each perk link was opened,
and the curl checks above were run.
- Observed result: the perks page responds 200 and states the same
3-months-with-12-month offer. The banner SVG is served as
`image/svg+xml` and parses. The table rows are true of `main` today:
`HEADROOM_MODEL_ROUTER_ENABLED`/`HEADROOM_MODEL_ROUTES` and
`HEADROOM_TOOL_SEARCH` are documented in
`docs/content/docs/configuration.mdx` and `proxy.mdx`.
- Not tested: dark-mode rendering of the banner in GitHub's mobile app.

## Runtime Rollout Safety

- Rollout-managed feature(s): none; this is README content only.
- Minimum rollout channel: n/a.
- Stable/default behavior changed: no.
- Kill switch / disable path: n/a.
- Unsafe override required: no.
- Qualification impact: none.
- Rollback path: revert this PR.

## Review Readiness

- [x] I have performed a self-review
- [x] This PR is ready for human review

## Checklist

- [x] My code follows the project's style guidelines
- [x] I have performed a self-review of my code
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [x] New and existing unit tests pass locally with my changes
- [x] I did **not** edit `CHANGELOG.md` — it is generated by
release-please from my Conventional Commit PR title (a CI guard enforces
this)

## Screenshots (if applicable)

The banner is `.github/assets/enterprise-perk.svg`; GitHub renders it in
the PR's file view.

## Additional Notes

- Tests are N/A: this is a docs-only change.
- **Review fixes are in `a31629dd`** and address @JerrettDavis's routing
correction and both Devin findings.
- The perks page does not yet record `utm_*`, so until it does, claims
from GitHub are attributed by hand.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: JD Davis <mxjerrett@gmail.com>
2026-10-07 10:58:59 -05:00
Tejas Chopra 7c4d696cf9 docs(readme): rebuild the README on the Headroom brand (#3392)
## What this is

A visual rebuild of the README, using the **published brand** from
[headroomlabs.ai/brand](https://www.headroomlabs.ai/brand) rather than
colours invented for the occasion, and restoring the reference material
an earlier draft of this branch had cut.

## The hero

`.github/assets/hero.svg` — one animated SVG, 880×356.

| Token | Hex | Use |
|---|---|---|
| Headroom Mint | `#00F0B5` | primary accent, the compressed bar, the
logomark |
| Obsidian Space | `#070A0F` | background |
| Midnight Panel | `#0C1118` | the uncompressed bar |
| Cyan Glow | `#65D8FF` | the cut line, the sweep |
| Slate Muted | `#98A4B3` | secondary type |

The logomark is reproduced at its **published geometry**, lifted from
`favicon.svg` and scaled — not redrawn, not recoloured, not stretched.
It happens to already be the product: two brackets around a long bar and
a short one.

Brand guidance says to place the mark on dark or high-contrast
backgrounds, so there is **one dark hero for both GitHub themes**. The
previous `<picture>` light variant would have put a mint mark on white,
which the guidelines rule out.

Three animations — the removed span fading, a cyan pass over the
compressed bar, and both `FATAL` markers pulsing in step — all disabled
under `prefers-reduced-motion`.

## Badges

- **[Trendshift — #1 Repository Of The
Day](https://trendshift.io/repositories/20881)**, restored. It was in
the README before and the earlier draft dropped it. The claim is
Trendshift's, not ours, which is the right way to make it.
- A **live star count** beside it (68.4k at time of writing), in mint.
- **No star-history chart.** star-history.com currently renders "GitHub
restricted access to star data" in place of the graph, so restoring it
would have added a large blank block. Worth revisiting when their API
access is back.
- **No codecov badge.** Under `headroomlabs-ai` codecov reports **6.7%
across 524 files**; the old `chopratejas` project reported **65%**. The
uploads have not fully landed since the org migration — a CI
configuration issue, not a real drop. The badge goes back when the
number is true.

## What came back

The earlier draft removed these. All restored, with the long ones inside
`<details>`:

- **Output token reduction** — verbosity steering, effort routing,
`headroom learn --verbosity`, `headroom output-savings` and the holdout
control. An entire shipped capability that had gone missing.
- **Agent compatibility matrix** — all 18 agents with their per-agent
notes.
- **Copilot CLI subscription mode**, **Copilot in VS Code**, **Claude
Code in VS Code**.
- **Corporate networks and SSL inspection** —
`CERTIFICATE_VERIFY_FAILED`, the Intel macOS ONNX Runtime workaround
(#941), and `HEADROOM_TLS_STRICT`. People arrive at a README searching
for exactly this.
- **`headroom learn`** and its GIF · **Headroom for teams** ·
**Integrations** · **What's inside** · **Pipeline internals** ·
**Updating** · **uv/pipx/MCP PATH notes**.

## Numbers

Unchanged from the audited set. The Proof table still cites
`benchmarks/index_proof_table.py --seed 20260902`; the accuracy table
still cites `python -m headroom.evals suite --tier 1`; TruthfulQA's
`+0.030` is still labelled as inside the confidence interval at N=100.

Also new: a **Telemetry** section. The README had never disclosed that
the beacon is on by default. It does now, with the opt-outs.

## Verification

- SVG validated as XML, rendered headless and reviewed.
- README rendered through GitHub's own markdown API and reviewed end to
end — that is how the broken star-history chart was caught.
- All 48 links checked. HuggingFace URLs deliberately stay on the
`chopratejas` account, which was not part of the org migration.
- HTML tag balance checked: 9 `<details>`, 9 `<summary>`, 3 `<div>`, all
closed.

668 lines, 4,104 words — comparable to the 616/4,228 it replaces, but
with the depth folded and a page that opens with something to look at.

Conflicts with #3389's README hunks; take this version wholesale.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

https://claude.ai/code/session_01HRaEPjQcCSAwD2xbQMNENu

---------
2026-09-02 16:40:34 +05:30