API Reference

State used to demonstrate an explicit documentation-test scenario.

Functions for constructing and pricing orders.

A customer order used throughout the deep-reference documentation.

No description available.

Defines the supported command-line arguments for the livedocs tool.

# ContentProvider `ContentProvider` loads Markdown, parses page metadata, expands transclusions, resolves semantic references, validates links, and copies documentation assets.

No description available.

Helpers for constructing and consuming renderer-neutral documentation.

Canonical discovery of expanded documentation code.

One fenced code block found by scanning for fence delimiters at the top nesting level.

No description available.

No description available.

Loads and verifies immutable inputs for a multi-version documentation build.

Creates, validates, inspects, and extracts deterministic release capsules.

Build-time semantic formatting for F# code embedded in documentation pages.

No description available.

No description available.

Recovers how the source actually wrote each parameter, for parameters the compiler's typed view cannot name.

# SymbolLister `SymbolLister` extracts public symbols and XML documentation from built F# projects.

No description available.

A quality problem found in the documented API itself, reported against the source that declares it.

Versioned, schema-tagged API model stored as a release artifact.

A synthetic script checked in one evaluated project context.

Metadata extracted from Markdown frontmatter.

A processed documentation page.

One expanded F# block shared by verification, extraction, and rendering.

The author-selected checking and execution policy for an F# block.

Where a documentation block was authored before deterministic expansion.

An FsLiveDocs-owned API documentation node persisted without presentation markup.

The renderer-neutral meaning of one API documentation node.

The domain kind for a documented API entity.

Represents an F# entity (Module, Type, Interface, etc.).

Represents an executable code example extracted from documentation.

Represents the evaluated result of a documentation example.

The evaluation status for a documentation example.

No description available.

No description available.

No description available.

The action owned by one stable generated verification case.

A self-contained case consumed through the single generated-verification runner interface.

One immutable API model and tagged documentation source in a history build.

Local build manifest materialized from a repository's durable release history.

Represents a member (function, value, or method) of an F# entity.

Build-time configuration for the generated documentation site.

The root model representing a documented package or solution.

The root model representing a documented package or solution.

Represents a parameter of a function or method.

Represents the snapshot payload for one project.

One non-Markdown file stored in the release capsule.

The self-contained, immutable input to a future history render.

Summary returned after a release capsule is written or inspected.

Inventory counts that make release capture observable without opening the capsule.

Integrity metadata for one component inside a release capsule.

Renderer-neutral documentation content for one release.

One canonical Markdown page captured for a documentation release.

One immutable capsule referenced by a history index.

A concise local history index for complete release capsules.

Resolved project paths and namespace information used by the doc-test runner.

Represents a setup scenario for a DocTest.

No description available.

No description available.

No description available.

No description available.

No description available.

No description available.

No description available.

Renderer-neutral semantic classification persisted for a documentation release.

No description available.

No description available.

Build-time configuration for the generated documentation site.

Represents a link to a specific line in a source file.

A deterministic action exposed to generated documentation tests.

Shared HTML shaping helpers for renderer pages and cards.

# SiteBuilder `SiteBuilder` renders guide pages, API pages, the API index, version navigation, and `llms.txt`.

Shared inputs for building the generated site.

Shared inputs for rendering a documentation page.

Centralized URL and path resolution helpers.

Contains the view components and layout templates for the documentation site.

# DocTestRunner `DocTestRunner` supports named XML documentation snapshots.

Evaluates the real MSBuild project and checks canonical documentation compilation units with FCS.

Runs FSI transcripts and formats the resulting output.

No description available.

The single stable execution boundary used by generated xUnit cases.

Resolves source projects and built assemblies for doc-test execution.

Converts compiler symbols immediately into renderer-neutral FsLiveDocs records.

No description available.

No description available.

No description available.

No description available.