mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-11-22 13:29:19 +08:00
## 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>
68 lines
2.5 KiB
TypeScript
68 lines
2.5 KiB
TypeScript
import { RootProvider } from 'fumadocs-ui/provider/next';
|
||
import { Banner } from 'fumadocs-ui/components/banner';
|
||
import './global.css';
|
||
import { Inter } from 'next/font/google';
|
||
import type { Metadata } from 'next';
|
||
|
||
const inter = Inter({
|
||
subsets: ['latin'],
|
||
});
|
||
|
||
// Canonical URL for the live docs. ``metadataBase`` resolves the og:url
|
||
// and twitter:url for every page; pointing it at the actual live site
|
||
// is what lets crawlers (search + LLM) follow the right canonical and
|
||
// pick up ``/llms.txt`` / ``/sitemap.xml`` / og images. The site now
|
||
// serves from the custom domain below; the old *.vercel.app host is
|
||
// kept out of here deliberately, because when this fell back to it the
|
||
// live site advertised a sitemap and ``Host:`` on the wrong domain.
|
||
// Override at build time via ``NEXT_PUBLIC_SITE_URL`` for previews.
|
||
const SITE_URL = process.env.NEXT_PUBLIC_SITE_URL ?? 'https://docs.headroomlabs.ai';
|
||
|
||
export const metadata: Metadata = {
|
||
title: {
|
||
default: 'Headroom — Context Optimization Layer for AI Agents',
|
||
template: '%s | Headroom',
|
||
},
|
||
description:
|
||
'Compress everything your AI agent reads — tool outputs, logs, files, RAG chunks. Same answers, fraction of the tokens. Library, proxy, MCP server. Local-first. Apache 2.0.',
|
||
metadataBase: new URL(SITE_URL),
|
||
alternates: {
|
||
canonical: '/',
|
||
},
|
||
openGraph: {
|
||
type: 'website',
|
||
siteName: 'Headroom',
|
||
title: 'Headroom — Context Optimization Layer for AI Agents',
|
||
description:
|
||
'Compress tool outputs, logs, files, and RAG chunks before they reach the LLM. 60–95% fewer tokens, same answers.',
|
||
url: '/',
|
||
},
|
||
twitter: {
|
||
card: 'summary_large_image',
|
||
title: 'Headroom — Context Optimization Layer for AI Agents',
|
||
description:
|
||
'Compress tool outputs, logs, files, and RAG chunks before they reach the LLM. 60–95% fewer tokens, same answers.',
|
||
},
|
||
};
|
||
|
||
export default function Layout({ children }: LayoutProps<'/'>) {
|
||
return (
|
||
<html lang="en" className={inter.className} suppressHydrationWarning>
|
||
<body className="flex flex-col min-h-screen">
|
||
<RootProvider>
|
||
{/* Dismissible; Fumadocs remembers the dismissal per id in localStorage. */}
|
||
<Banner id="teams-contact-2026">
|
||
<a
|
||
href="https://headroomlabs.ai"
|
||
className="font-medium underline-offset-4 hover:underline"
|
||
>
|
||
Want more savings? Headroom for teams and enterprises: talk to us →
|
||
</a>
|
||
</Banner>
|
||
{children}
|
||
</RootProvider>
|
||
</body>
|
||
</html>
|
||
);
|
||
}
|