Skip to content
K

Feature Status

See which Ardo capabilities are shipped, experimental, planned, or currently not planned.

Ardo is moving quickly, so this page keeps product claims grounded. It separates what is ready to use today from larger roadmap areas that still need design work.

Shipped

These capabilities are available in the current package line.

AreaStatusNotes
React Router docs shellShippedReact Router 8 app shell, static prerendering, and file-based routes.
Markdown and MDX routesShippedMarkdown, MDX, GFM, frontmatter, TOC extraction, and built-in MDX component mapping.
Syntax highlightingShippedBuild-time Shiki highlighting for Markdown code fences and static CodeBlock usage.
SearchShippedGenerated search data with a built-in search UI.
TypeDoc API referenceShippedBuilt into the ardo() plugin for TypeScript library APIs.
Social metadataShippedGenerated canonical, Open Graph, and Twitter metadata for Markdown routes.
SEO build outputsShippedSitemap, robots output, LLM text artifacts, link checking, and static redirects are supported.
Theme hue overridesShippedBrand, accent, and neutral hue custom properties can retint the default color ramp from CSS.
Core content componentsShippedBadge, Card, CardGroup, Tabs, Accordion, AccordionGroup, callouts, steps, code blocks, hero, and features.
Storybook playgroundShippedDefault UI components have a local and static Storybook workflow.

Experimental

These areas work, but the API or maintenance story may still evolve.

AreaStatusNotes
TypeDoc customizationExperimentalUseful today, but richer category, grouping, and rendering controls may still change.
Theme token overridesExperimentalCSS variables and Vanilla Extract tokens are public, but the broader theming API and build-time customization story may still change.

Planned

These are useful, but not part of the shipped core yet.

AreaTracking issueNotes
Documentation versioning#78Needs a narrower first slice around directory-based versions, shared content, and aliases.
Internationalization#79Needs decisions around route trees, search, sidebar behavior, RTL, fallbacks, and per-locale SEO.
OpenAPI documentation#69The first slice should likely be static reference generation before an interactive playground.
Mermaid diagrams#67Needs a rendering strategy that works reliably with static builds and light/dark themes.
Migration guides#134Guides from Docusaurus, Starlight, VitePress, and Mintlify are still needed.
Build performance budgets#178CI should eventually catch build-time, plugin-time, bundle-size, and search-index regressions.
Lint warning budget#179Known warnings need to become an explicit quality budget.

Nice To Have

These are useful for some teams but are not central to the first documentation framework surface.

AreaTracking issueNotes
Tooltip component#81Needs careful accessibility and mobile interaction design.
Page feedback widget#74The UI is small; the harder part is deciding where feedback data goes.
Math notation#68Browser-native MathML may keep this lightweight if the markdown pipeline integration stays simple.
Custom font configuration#77Most teams can already handle this through CSS and app-level head customization.

Not Planned

Ardo is intentionally not trying to become every kind of documentation product.

AreaReason
Hosted editing workflowArdo is repository-native and self-hosted. Teams that want hosted collaboration should use a hosted docs platform.
Built-in analytics productStatic deployments can integrate analytics providers directly; Ardo does not need to own event storage.
Lowest-JavaScript prose siteArdo prioritizes React-native reuse. Astro, VitePress, or Starlight can be better for prose-only sites.

Maintenance

Update this page when a feature PR lands, when an issue is closed as not planned, or when a roadmap item gets split into a smaller first slice.