Embedded Help Panels
Add contextual help surfaces that link back to Compass articles without turning docs into a separate product.
Embedded help panels are useful when readers need guidance without leaving the flow they are already in.
Good places for an embed
- settings pages with advanced options
- onboarding steps with setup instructions
- admin views that need just-in-time explanation
Keep the source of truth in Compass
The embed should point to or summarize content that already exists in src/content/docs, not become a second documentation system.
That usually means:
- linking to a full article
- showing a short checklist pulled from the same source
- deep-linking to a specific heading in a longer guide
Example container
<aside class="help-panel">
<h2>Need help?</h2>
<p>Open the setup guide without leaving this page.</p>
<a href="/getting-started/compass-docs/manage-docs">View guide</a>
</aside>Implementation notes
- keep embedded copy shorter than the full article
- avoid duplicating release-sensitive instructions in multiple places
- use Compass as the canonical place for updates