Skip to content

Add a Managed Nebula note to the right sidebar - #411

Merged
bgolat merged 4 commits into
mainfrom
claude/copy-feedback-217b41
Nov 12, 2026
Merged

bgolat merged 4 commits into
mainfrom
claude/copy-feedback-217b41

Conversation

@bgolat

@bgolat bgolat commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Why

Many visitors land directly on the specific page they searched for (a config reference, a guide) and never see the docs homepage, which is currently the only place Managed Nebula is mentioned. They may not know there's a hosted option at all.

This adds a small, text-only note under "On this page" in the right sidebar so the hosted option is discoverable across the docs. The goal is to stay out of the way and avoid feeling spammy: no box, no image, no banner in the content flow, and it never repeats a callout that's already on the page.

What changed

  • Sidebar note (src/components/starlight/PageSidebar.astro): a new override of Starlight's PageSidebar that renders the default TOC, then a three-line note below it:

    MANAGED NEBULA
    Hosted lighthouse and CA, with automatic certificate rotation.
    Free for up to 100 hosts →

    It reuses the site's sidebar classes, so its width and gutter match the TOC exactly.

  • Opt-out flag: a new managedPromo frontmatter field (default true). The docs homepage sets it to false, since it already has its own callout.

  • Rotating a CA guide: removed the "Sick of manually managing IP addresses…" callout at the end. The sidebar note covers that page now, so it would just repeat it.

  • Homepage callout: tightened copy (names the hosted lighthouse and who's behind it), and moved the link inline to make the box shorter.

  • UTMs on both signup links so signups can be attributed by placement:

    • callout: utm_medium=callout&utm_content=docs-home
    • sidebar: utm_medium=sidebar&utm_content=<page slug>
    • both: utm_source=nebula-docs&utm_campaign=managed-nebula

Where the note doesn't show

  • Below desktop width, where Starlight hides the right sidebar (it's deliberately kept out of the mobile TOC dropdown).
  • The section index pages (Guides, Config reference, Security bulletins), which have no TOC and so no right sidebar.

Notes for review

  • UTMs are recorded by analytics on admin.defined.net, not by the docs site's Plausible. Worth confirming the signup flow keeps them.
  • When comparing placements, use click rate per page view: the sidebar is on far more pages, so raw totals will favor it.

Testing

  • Checked in the dev server at 1440×900, light and dark mode: the note aligns with the TOC, and on the longest TOC (Unsafe routes) it still sits above the fold.
  • Confirmed the note is absent on the docs homepage and present elsewhere, and the rendered UTM hrefs are correct per page.
  • prettier --check, pnpm test, and astro check pass.

🤖 Generated with Claude Code

Most docs visitors land on the page they searched for and never see the
homepage, which was the only place the hosted option was mentioned. Add a
short text-only note under "On this page" so it's visible across the docs
without interrupting the content.

- New PageSidebar override renders the note below the TOC on desktop.
- `managedPromo: false` frontmatter hides it on pages that already have
  their own callout (the docs homepage).
- Tighten the homepage callout copy and inline its link.
- Tag both signup links with UTMs (medium: callout / sidebar, content:
  page slug) so signups can be attributed by placement.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for docs-nebula ready!

Name Link
🔨 Latest commit 371e244
🔍 Latest deploy log https://github.com/DefinedNet/nebula-docs/actions/runs/43280461467
😎 Deploy Preview Url https://5b220382.docs-nebula.pages.dev
😎 Deploy Preview Alias https://claude-copy-feedback-217b41.docs-nebula.pages.dev

@bgolat
bgolat marked this pull request as ready for review November 12, 2026 18:08
jasikpark
jasikpark previously approved these changes Nov 12, 2026

@jasikpark jasikpark left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving. One thing before merge: the rotating-CA guide already ends with its own Managed Nebula note (guides/rotating-certificate-authority/index.mdx ~L182), so it'll show both. Probably want managedPromo: false there, plus UTMs on that link (utm_medium=callout&utm_content=guides/rotating-certificate-authority) so it shows up in the per-placement numbers too.

Nit: the stale-cache comment on showPromo can go. !== false already reads right.

The footer overlap is fixed separately in #413.

— Caleb + Cache

The sidebar note now covers this page, so the end-of-guide pitch would
repeat it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@bgolat

bgolat commented Nov 12, 2026

Copy link
Copy Markdown
Contributor Author

Thanks! The rotating-CA callout is removed in 2020ff1 instead of opting that page out. The sidebar note is now the only pitch there, which keeps the page less salesy. Dropped the cache comment too. The push dismissed your approval, so it needs another look when you have a sec.

@bgolat
bgolat requested a review from jasikpark November 12, 2026 18:29
@bgolat
bgolat merged commit 813178e into main Nov 12, 2026
6 checks passed
@bgolat
bgolat deleted the claude/copy-feedback-217b41 branch November 12, 2026 18:33
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