Skip to main content

In-page components

Tip​

Two modes in one component:

  • Legacy, pass text and get a pure-CSS hover tooltip.
  • Two-stage, pass shortInfo (and optionally longInfo): hover shows the short info, clicking expands the full explanation inline, and an optional href appends a "Learn more" link. Hides after a 150 ms delay on mouse leave, closes on outside click, and collapses fully on dismiss.

LinkedIssues​

A collapsible "Linked Issues" row (with a count badge) for use near the top of MDX pages. Items need only label and url; status, type, and labels are fetched from the GitHub API the first time the section is expanded, then cached in localStorage for five minutes keyed by the item URLs. Rendered enrichment includes Issue/PR badges, open/closed markers, and label chips colored from each label's GitHub color. Non-GitHub URLs are displayed as plain links without enrichment. An optional defaultOpen prop starts the section expanded.

AiGeneratedBanner​

A collapsed-by-default <details> banner declaring how the page was produced. Three generation types are registered internally:

TypeMeaning
ai-generated (default)Page drafted entirely by AI from the codebase or prompt instructions
ai-transformattedHuman provided raw material; AI restructured it (livestream to blog post, meeting notes to docs)
human-generatedPage written entirely by a human author

Optional props: humanCurated (adds a checked "curated" badge and review sentence), generatedAt and model (shown as metadata rows), humanNotes (curator notes in an accented block), and moreInfoUrl (defaults to the generation-types explainer on the deployed SkellyDocs site; pass an empty string to hide the link). Expanding the banner also reveals a nested overview of all three types with the current one highlighted. Passing repo turns the disclaimer into an actionable one. It links to a prefilled documentation-issue template in that repo.

Per its own repo convention (stated in its CLAUDE.md), every .mdx page starts with <AiGeneratedBanner />.

CoreFeatureHeader​

Renders a feature's icon, summary, and linked issues as a header block, so a feature's doc page visually matches its card on the landing page.