string Value { get; init; }
Source
Gets the normalized machine-readable page-type value.
Models
DocPageTypeBadgePresentation
SourcePresentation metadata for one normalized documentation page-type badge.
Value
Label
string Label { get; init; }
Source
Gets the human-readable badge label.
Variant
string Variant { get; init; }
Source
Gets the badge variant suffix used by built-in RazorDocs CSS classes such as docs-page-badge--guide.
DocMetadataPresentation
SourceConverts raw documentation metadata values into consistent UI-facing labels and badge variants.
Remarks
Use this helper from Razor views, search payload generation, or custom UI surfaces when you want the built-in RazorDocs page-type treatment to remain consistent across landing, detail, and search experiences.
ResolvePageTypeBadge
DocPageTypeBadgePresentation? ResolvePageTypeBadge(string? pageType)
Source
Resolves the built-in RazorDocs page-type badge presentation for a raw metadata value.
Parameters
pageTypeThe raw page-type metadata value, such asguide,api-reference, orrelease-note.
Returns
A normalized badge presentation when pageType is non-empty; otherwise, null. Release aliases such as release-note and release-notes resolve to the canonical release badge value. Unknown page types fall back to a neutral badge with a title-cased label.
NormalizeToken
string? NormalizeToken(string? value)
Source
Normalizes a raw metadata token into a lowercase dash-delimited value.
Parameters
valueRaw metadata token that may contain whitespace, underscores, dashes, or line breaks.
Returns
A normalized token, or null when value is null, whitespace, or produces no non-delimiter segments after trimming and splitting.
Remarks
RazorDocs trims the input, splits on spaces, tabs, carriage returns, line feeds, underscores, and hyphens, removes empty segments, lowercases each remaining segment, and rejoins them with -.
DocMetadata
SourceStructured metadata that can drive navigation, breadcrumbs, related links, and search without re-parsing source content.
Title
string? Title { get; init; }
Source
Gets the resolved display title for the documentation node.
Summary
string? Summary { get; init; }
Source
Gets a short summary describing the documentation node.
SummaryIsDerived
bool? SummaryIsDerived { get; init; }
Source
Gets a value indicating whether Summary was derived from page content instead of authored explicitly.
PageType
string? PageType { get; init; }
Source
Gets the page type, such as guide, example, api-reference, or troubleshooting.
Audience
string? Audience { get; init; }
Source
Gets the intended audience for the page.
Component
string? Component { get; init; }
Source
Gets the product component associated with the page.
Aliases
IReadOnlyList<string>? Aliases { get; init; }
Source
Gets alternate terms that should resolve to this page in search.
RedirectAliases
IReadOnlyList<string>? RedirectAliases { get; init; }
Source
Gets alternate route aliases that should redirect to the canonical page when redirect support is enabled.
Keywords
IReadOnlyList<string>? Keywords { get; init; }
Source
Gets search keywords associated with the page.
Status
string? Status { get; init; }
Source
Gets the content lifecycle status for the page.
Order
int? Order { get; init; }
Source
Gets the relative ordering value within a navigation group.
SequenceKey
string? SequenceKey { get; init; }
Source
Gets the explicit sequence identifier used to connect pages into one proof path.
Remarks
RazorDocs does not infer sequence membership from folders or filenames in this slice. Pages participate in next/previous wayfinding only when authors opt them into the same SequenceKey and assign comparable Order values.
SectionLanding
bool? SectionLanding { get; init; }
Source
Gets a value indicating whether the page is the authored landing doc for its public section.
HideFromSearch
bool? HideFromSearch { get; init; }
Source
Gets a value indicating whether the page should be hidden from search.
RelatedPages
IReadOnlyList<string>? RelatedPages { get; init; }
Source
Gets related page identifiers or titles.
CanonicalSlug
string? CanonicalSlug { get; init; }
Source
Gets the preferred canonical slug for the page.
Breadcrumbs
IReadOnlyList<string>? Breadcrumbs { get; init; }
Source
Gets optional human-readable breadcrumb labels for the page.
FeaturedPageGroups
IReadOnlyList<DocFeaturedPageGroupDefinition>? FeaturedPageGroups { get; init; }
Source
Gets optional landing-page curation groups authored with the documentation page.
Remarks
RazorDocs parses this metadata on any page so the contract stays page-agnostic. Authors can supply groups either inline in Markdown front matter or through a paired sidecar such as README.md.yml. The built-in docs landing consumes the repository-root README.md groups, and section landing docs consume their own groups for reader-intent next steps.
Trust
DocTrustMetadata? Trust { get; init; }
Source
Gets optional trust and provenance metadata rendered near the top of the page.
Remarks
This nested object is designed for release notes, upgrade policies, changelogs, and similar pages that need to communicate current status, adoption safety, and archival provenance without custom view logic.
Contributor
DocContributorMetadata? Contributor { get; init; }
Source
Gets optional contributor provenance metadata for page-level source, edit, and freshness control.
BreadcrumbsMatchPathTargets
bool? BreadcrumbsMatchPathTargets { get; init; }
Source
Gets a value indicating whether authored breadcrumb labels align with the path-derived breadcrumb targets that RazorDocs can safely reuse for rendering.
DocOutlineItem
SourceRepresents one navigable heading captured while harvesting a documentation page.
Title
string Title { get; init; }
Source
Gets the heading text shown in the page-local outline and search metadata.
Id
string Id { get; init; }
Source
Gets the HTML fragment identifier that anchors this outline item within the page.
Level
int Level { get; init; }
Source
Gets the normalized heading level for this entry.
DocTrustMetadata
SourceStructured trust and provenance metadata for a documentation page.
Status
string? Status { get; init; }
Source
Gets the compact top-level state shown in the trust bar, such as Unreleased or Pre-1.0 policy.
Summary
string? Summary { get; init; }
Source
Gets the short trust statement that explains what the current status means for readers.
Freshness
string? Freshness { get; init; }
Source
Gets the freshness statement that explains how current or provisional the page is.
ChangeScope
string? ChangeScope { get; init; }
Source
Gets the statement describing which product surfaces or artifacts this page covers.
Migration
DocTrustLink? Migration { get; init; }
Source
Gets an optional link to migration or upgrade guidance.
Archive
string? Archive { get; init; }
Source
Gets the archival or long-term home statement for the page contents.
Sources
IReadOnlyList<string>? Sources { get; init; }
Source
Gets optional provenance notes or upstream sources that support the page.
DocTrustLink
SourceLink metadata used by trust-bar actions such as migration guidance.
Label
string? Label { get; init; }
Source
Gets the reader-facing link label.
Href
string? Href { get; init; }
Source
Gets the browser-facing destination URL.
DocContributorMetadata
SourcePage-level contributor provenance metadata used to override or suppress source, edit, and freshness evidence.
Merge
DocContributorMetadata? Merge(DocContributorMetadata? primary, DocContributorMetadata? fallback)
Source
Merges contributor metadata by preferring authored primary values and filling missing values from fallback metadata.
Remarks
Precedence rules:HideContributorInfouses nullable-boolean precedence, so explicitfalseis preserved.SourcePathOverride,SourceUrlOverride, andEditUrlOverrideprefer the first non-blank string; whitespace-only values are treated as missing.LastUpdatedOverrideuses null coalescing and therefore keeps the primary timestamp when present.
- Setting a string override to the empty string does not clear a fallback value; it falls back instead.
- Callers that need to suppress inherited contributor rendering should use
HideContributorInfoinstead of relying on blank string overrides.
HideContributorInfo
bool? HideContributorInfo { get; init; }
Source
Gets a value indicating whether contributor provenance should be hidden for the page even when automatic evidence exists.
SourcePathOverride
string? SourcePathOverride { get; init; }
Source
Gets an optional repository-relative source-path override used for source links, edit links, and git freshness resolution. Rooted paths and traversal segments are rejected.
SourceUrlOverride
string? SourceUrlOverride { get; init; }
Source
Gets an optional explicit source URL override. Only absolute HTTP(S) URLs and root-relative paths are accepted.
EditUrlOverride
string? EditUrlOverride { get; init; }
Source
Gets an optional explicit edit URL override. Only absolute HTTP(S) URLs and root-relative paths are accepted.
LastUpdatedOverride
DateTimeOffset? LastUpdatedOverride { get; init; }
Source
Gets an optional exact timestamp override for contributor freshness.
DocSymbolSourceProvenance
SourceIdentifies the source declaration that produced one rendered C# API documentation symbol.
AnchorId
string AnchorId { get; init; }
Source
Gets the rendered HTML anchor ID for the generated API symbol.
SourcePath
string SourcePath { get; init; }
Source
Gets the repository-relative source file path that contains the documented declaration.
StartLine
int StartLine { get; init; }
Source
Gets the 1-based source declaration line.
DocNode
SourceRepresents a documentation node within the repository.
Parameters
TitleThe display title of the document.PathThe relative path to the documentation source.ContentThe rendered HTML content of the documentation.ParentPathThe optional parent path for hierarchical organization.IsDirectoryIndicates if this node represents a directory container.CanonicalPathThe browser-facing docs route path used for linking and lookup.MetadataStructured metadata associated with the documentation node.OutlineStructured in-page outline entries captured during harvesting.SymbolSourceProvenanceOptional source declarations keyed by rendered C# API symbol anchor IDs.
DocHarvestHealthSnapshot
SourceCaptures the structured health of one RazorDocs harvest snapshot.
Parameters
StatusOverall health rollup for the snapshot.GeneratedUtcUTC timestamp when the snapshot was generated.RepositoryRootRepository root passed to configured harvesters. Treat this as server-only operational data because it can contain sensitive or environment-specific filesystem paths; redact or omit it before sending snapshots to clients.TotalHarvestersNumber of harvesters configured for the snapshot.SuccessfulHarvestersNumber of harvesters that completed with either docs or a valid empty result.FailedHarvestersNumber of harvesters that failed, timed out, or canceled.TotalDocsNumber of documentation nodes published by the final cached docs snapshot.HarvestersPer-harvester health entries. Nevernullin RazorDocs-created snapshots.DiagnosticsStructured diagnostics for failed, degraded, or noteworthy states. Nevernullin RazorDocs-created snapshots.
Remarks
RazorDocs-created snapshots retain non-null Harvesters and Diagnostics collections for safe server-side inspection, but callers that serialize this record into client-visible payloads must sanitize RepositoryRoot first.
DocHarvesterHealth
SourceCaptures one configured harvester's status inside a RazorDocs harvest snapshot.
Parameters
HarvesterTypeConcrete harvester type name used in logs and diagnostics.StatusHarvester-level health status.DocCountNumber of documentation nodes returned by the harvester before RazorDocs post-processing.DiagnosticDiagnostic explaining a failed, timed-out, or canceled harvester; usuallynullfor non-failure outcomes.
DocHarvestDiagnostic
SourceDescribes one structured RazorDocs harvest health diagnostic.
Parameters
CodeStable diagnostic code suitable for tests, logs, documentation, and host UI branching.SeverityDiagnostic severity.HarvesterTypeConcrete harvester type when the diagnostic belongs to one harvester, ornullfor aggregate diagnostics.ProblemOperator-facing summary of what went wrong.CauseExplanation of why RazorDocs could not safely treat the harvest as fully healthy.FixSuggested operator or docs-author action that resolves the problem.
DocHarvestDiagnosticCodes
SourceDefines the stable diagnostic codes emitted by RazorDocs harvest health snapshots.
Remarks
Use these constants when testing or branching on DocHarvestDiagnostic.Code values. The string values are public compatibility contracts and must not be changed once released.
DocSectionSnapshot
SourceRepresents one normalized public-section snapshot derived from the harvested docs corpus.
Section
DocPublicSection Section { get; init; }
Source
Gets the typed public section identifier.
Label
string Label { get; init; }
Source
Gets the canonical display label for the section.
Slug
string Slug { get; init; }
Source
Gets the stable route slug for the section.
LandingDoc
DocNode? LandingDoc { get; init; }
Source
Gets the optional authored landing doc that represents the section.
VisiblePages
IReadOnlyList<DocNode> VisiblePages { get; init; }
Source
Gets the public pages that belong to the section, ordered for display.
DocFeaturedPageGroupDefinition
SourceDefines one authored reader-intent group for a docs landing surface.
Intent
string? Intent { get; init; }
Source
Gets the stable reader-intent identifier for the group.
Remarks
Authors may omit this value when Label is present. RazorDocs derives a normalized intent from the label during metadata parsing so downstream resolvers can still identify the group consistently.
Label
string? Label { get; init; }
Source
Gets the reader-facing group heading.
Remarks
Authors may omit this value when Intent is present. RazorDocs converts the intent into a title-cased label during metadata parsing so the landing can still render a useful heading.
Summary
string? Summary { get; init; }
Source
Gets optional copy that explains when a reader should choose the group.
Order
int? Order { get; init; }
Source
Gets the relative display order for the group.
Pages
IReadOnlyList<DocFeaturedPageDefinition> Pages { get; init; }
Source
Gets the featured destination pages in this group.
SourceFieldPath
string? SourceFieldPath { get; init; }
Source
Gets the parser-populated metadata field path for group-level diagnostics.
Remarks
This internal value is for diagnostics and source attribution only. Authored metadata and consumers should not depend on it as stable content because the parser path format may change.
DocFeaturedPageDefinition
SourceDefines one authored featured-page entry for a docs landing surface.
Question
string? Question { get; init; }
Source
Gets the reader-facing evaluator question or label for the card.
Remarks
When this value is omitted on the built-in docs landing, RazorDocs falls back to the resolved destination page title so the card still renders with a sensible label.
Path
string? Path { get; init; }
Source
Gets the source or canonical path of the destination page to feature.
Remarks
RazorDocs matches both source paths and canonical browser paths. Path separators are normalized during resolution so authored forward-slash and backslash forms point to the same destination.
SupportingCopy
string? SupportingCopy { get; init; }
Source
Gets optional landing-only supporting copy shown instead of destination summary text.
Order
int? Order { get; init; }
Source
Gets the relative display order for the featured entry.
SourceFieldPath
string? SourceFieldPath { get; init; }
Source
Gets the parser-populated metadata field path for page-level diagnostics.
Remarks
This internal value is for diagnostics and source attribution only. Authored metadata and consumers should not depend on it as stable content because the parser path format may change.
DocLandingViewModel
SourceView model for the docs landing page.
Heading
string Heading { get; init; }
Source
Gets the hero heading shown on the docs landing.
Description
string Description { get; init; }
Source
Gets the supporting description shown under the hero heading.
LandingDoc
DocNode? LandingDoc { get; init; }
Source
Gets the repository-root landing document when one was harvested.
StartHereHref
string? StartHereHref { get; init; }
Source
Gets the href for the section-level Start Here route when that section exists in the current public docs corpus.
VisibleDocs
IReadOnlyList<DocNode> VisibleDocs { get; init; }
Source
Gets the visible documentation nodes used by the neutral fallback landing state.
FeaturedPageGroups
IReadOnlyList<DocLandingFeaturedPageGroupViewModel> FeaturedPageGroups { get; init; }
Source
Gets the resolved proof-path groups for the landing experience.
SecondarySections
IReadOnlyList<DocHomeSectionViewModel> SecondarySections { get; init; }
Source
Gets the secondary section summaries shown under the primary Start Here route.
HasFeaturedPages
bool HasFeaturedPages { get; }
Source
Gets a value indicating whether the landing should render a proof-path lead section.
DocLandingFeaturedPageGroupViewModel
SourceView model for one resolved reader-intent group on a docs landing page.
Remarks
Intent and Label are normalized by the featured-page resolver before rendering: authored whitespace is trimmed, missing labels fall back to the resolved intent, and both values are non-null. Summary contains optional group copy and may be null. Pages contains the resolved DocLandingFeaturedPageViewModel rows produced by the resolver after it matches authored destinations to visible docs. Empty Pages lists are treated as no featured pages and are suppressed by DocLandingViewModel.HasFeaturedPages, DocDetailsViewModel.HasFeaturedPages, and the RazorDocs views. Pitfalls: callers should not rely on an empty Pages list being rendered, and should expect Intent, Label, Summary, and Pages to reflect resolver output rather than raw authored front matter.
Intent
string Intent { get; init; }
Source
Gets the stable reader-intent identifier for the group.
Label
string Label { get; init; }
Source
Gets the reader-facing group label.
Summary
string? Summary { get; init; }
Source
Gets optional copy that explains when to choose this group.
Pages
IReadOnlyList<DocLandingFeaturedPageViewModel> Pages { get; init; }
Source
Gets the resolved featured-page rows in this group.
DocLandingFeaturedPageViewModel
SourceView model for one resolved featured card on the docs landing page.
Question
string Question { get; init; }
Source
Gets the evaluator question or label shown on the card.
Title
string Title { get; init; }
Source
Gets the destination page title shown on the card.
Href
string Href { get; init; }
Source
Gets the browser-facing link to the destination page.
PageType
string? PageType { get; init; }
Source
Gets the destination page type, such as guide, example, or api-reference.
PageTypeBadge
DocPageTypeBadgePresentation? PageTypeBadge { get; init; }
Source
Gets the normalized badge presentation for PageType when RazorDocs can render one.
SupportingText
string? SupportingText { get; init; }
Source
Gets the supporting body copy shown on the card.
DocHomeSectionViewModel
SourceView model describing one secondary public-section summary on the docs home.
Section
DocPublicSection Section { get; init; }
Source
Gets the typed public section represented by the summary.
Label
string Label { get; init; }
Source
Gets the section label shown to the reader.
Slug
string Slug { get; init; }
Source
Gets the stable route slug for the section.
Href
string Href { get; init; }
Source
Gets the route that enters the section.
Purpose
string Purpose { get; init; }
Source
Gets the one-sentence utility copy that explains what the reader can do in the section.
KeyRoutes
IReadOnlyList<DocSectionLinkViewModel> KeyRoutes { get; init; }
Source
Gets the key routes surfaced for the section on the docs home.
DocBreadcrumbViewModel
SourceView model for a section-scoped or doc-scoped breadcrumb item.
Label
string Label { get; init; }
Source
Gets the breadcrumb label shown to the reader.
Href
string? Href { get; init; }
Source
Gets the optional target href for the breadcrumb.
DocSectionLinkViewModel
SourceView model for one section list or sidebar link.
Title
string Title { get; init; }
Source
Gets the displayed link title.
Href
string Href { get; init; }
Source
Gets the destination href.
Summary
string? Summary { get; init; }
Source
Gets optional utility copy shown with the link.
Eyebrow
string? Eyebrow { get; init; }
Source
Gets optional short eyebrow text shown above the link title.
PageTypeBadge
DocPageTypeBadgePresentation? PageTypeBadge { get; init; }
Source
Gets the normalized page-type badge for the destination when one is available.
Children
IReadOnlyList<DocSectionLinkViewModel> Children { get; init; }
Source
Gets nested child links shown under the current link.
IsCurrent
bool IsCurrent { get; init; }
Source
Gets a value indicating whether this link represents the current page.
DocSectionGroupViewModel
SourceView model for one grouped set of section links.
Title
string? Title { get; init; }
Source
Gets the optional group heading shown above the link list.
Links
IReadOnlyList<DocSectionLinkViewModel> Links { get; init; }
Source
Gets the links that belong to the group.
DocPageLinkViewModel
SourceView model for one resolved documentation link shown in related or sequence wayfinding.
Title
string Title { get; init; }
Source
Gets the destination page title.
Href
string Href { get; init; }
Source
Gets the browser-facing destination URL.
Summary
string? Summary { get; init; }
Source
Gets optional supporting text for the destination.
PageTypeBadge
DocPageTypeBadgePresentation? PageTypeBadge { get; init; }
Source
Gets the normalized page type badge metadata for the destination when available.
DocSidebarViewModel
SourceView model for the sidebar navigation shell.
Sections
IReadOnlyList<DocSidebarSectionViewModel> Sections { get; init; }
Source
Gets the sections shown in the sidebar.
HarvestHealth
DocSidebarHarvestHealthViewModel? HarvestHealth { get; init; }
Source
Gets the harvest health sidebar entry when the current host should show health chrome.
DocSidebarHarvestHealthViewModel
SourceView model for the RazorDocs harvest health sidebar entry.
Status
string Status { get; init; }
Source
Gets the aggregate harvest status label.
Ok
bool Ok { get; init; }
Source
Gets a value indicating whether the status should pass local or CI verification.
Href
string? Href { get; init; }
Source
Gets the app-relative health page route when health routes are exposed; otherwise null for status-only chrome.
DocSidebarSectionViewModel
SourceView model for one public section in the sidebar.
Section
DocPublicSection Section { get; init; }
Source
Gets the typed section represented by the sidebar entry.
Label
string Label { get; init; }
Source
Gets the section label shown in the sidebar.
Slug
string Slug { get; init; }
Source
Gets the stable section slug.
Href
string Href { get; init; }
Source
Gets the section route href.
IsActive
bool IsActive { get; init; }
Source
Gets a value indicating whether the section owns the current page context.
IsExpanded
bool IsExpanded { get; init; }
Source
Gets a value indicating whether the section should render expanded by default.
Groups
IReadOnlyList<DocSectionGroupViewModel> Groups { get; init; }
Source
Gets the grouped links rendered when the section is expanded.
DocSectionPageViewModel
SourceView model for the grouped-section fallback and unavailable section surfaces.
Section
DocPublicSection? Section { get; init; }
Source
Gets the typed section when the route resolved to a known built-in section.
Heading
string Heading { get; init; }
Source
Gets the section label or unavailable-page heading.
Description
string Description { get; init; }
Source
Gets the primary explanatory copy for the page.
DocsHomeHref
string DocsHomeHref { get; init; }
Source
Gets the docs home route.
StartHereHref
string? StartHereHref { get; init; }
Source
Gets the href for the section-level Start Here route when that section exists in the current public docs corpus.
AvailabilityMessage
string? AvailabilityMessage { get; init; }
Source
Gets the explanatory copy shown when the section is unavailable.
IsSparse
bool IsSparse { get; init; }
Source
Gets a value indicating whether the fallback section is intentionally sparse.
KeyRoutes
IReadOnlyList<DocSectionLinkViewModel> KeyRoutes { get; init; }
Source
Gets the key routes surfaced for a sparse section fallback.
Groups
IReadOnlyList<DocSectionGroupViewModel> Groups { get; init; }
Source
Gets the grouped page lists shown for the section.
DocDetailsViewModel
SourceView model for a rendered documentation details page.
Document
DocNode Document { get; init; }
Source
Gets the underlying documentation node.
Outline
IReadOnlyList<DocOutlineItem> Outline { get; init; }
Source
Gets the in-page outline entries for the current document.
PreviousPage
DocPageLinkViewModel? PreviousPage { get; init; }
Source
Gets the previous page within the current authored sequence, when one exists.
NextPage
DocPageLinkViewModel? NextPage { get; init; }
Source
Gets the next page within the current authored sequence, when one exists.
RelatedPages
IReadOnlyList<DocPageLinkViewModel> RelatedPages { get; init; }
Source
Gets the authored related pages that resolved successfully.
ContributorProvenance
DocContributorProvenanceViewModel? ContributorProvenance { get; init; }
Source
Gets the contributor provenance evidence resolved for the current page.
Title
string Title { get; init; }
Source
Gets the resolved display title for the page.
Summary
string? Summary { get; init; }
Source
Gets the authored summary that should be rendered under the title when available.
ShowSummary
bool ShowSummary { get; init; }
Source
Gets a value indicating whether Summary should be rendered.
IsCSharpApiDoc
bool IsCSharpApiDoc { get; init; }
Source
Gets a value indicating whether the page is a C# API reference document.
IsApiSurfaceDoc
bool IsApiSurfaceDoc { get; init; }
Source
Gets a value indicating whether the page should use the API reference reading surface.
Remarks
This covers non-Markdown generated documents and Markdown documents explicitly marked with API-oriented metadata, while IsCSharpApiDoc remains scoped to C# generated page chrome decisions.
PageTypeBadge
DocPageTypeBadgePresentation? PageTypeBadge { get; init; }
Source
Gets the normalized page-type badge presentation for the current page when available.
Component
string? Component { get; init; }
Source
Gets the explicit component metadata shown with the page when available.
Audience
string? Audience { get; init; }
Source
Gets the explicit audience metadata shown with the page when available.
Breadcrumbs
IReadOnlyList<DocBreadcrumbViewModel> Breadcrumbs { get; init; }
Source
Gets the breadcrumb trail used by the page.
PublicSection
DocPublicSection? PublicSection { get; init; }
Source
Gets the current public section when the page belongs to a public docs section.
PublicSectionLabel
string? PublicSectionLabel { get; init; }
Source
Gets the current public-section label when one exists.
PublicSectionHref
string? PublicSectionHref { get; init; }
Source
Gets the current public-section route href when one exists.
PublicSectionPurpose
string? PublicSectionPurpose { get; init; }
Source
Gets the current public-section utility sentence when one exists.
TrustMigrationUsesTurbo
bool TrustMigrationUsesTurbo { get; init; }
Source
Gets a value indicating whether the trust-bar migration link should stay inside the docs content frame.
Remarks
This is resolved from the harvested docs corpus rather than inferred from the raw href alone so root-mounted docs surfaces can still treat canonical plain .html docs routes as docs-local without misclassifying unrelated site pages.
ContributorSourceUsesTurbo
bool ContributorSourceUsesTurbo { get; init; }
Source
Gets a value indicating whether the contributor source link should stay inside the docs content frame.
Remarks
This is resolved from the harvested docs corpus rather than inferred from the raw href alone so mounted or root-hosted docs surfaces can keep local provenance links inside the docs shell without trapping unrelated app routes.
ContributorEditUsesTurbo
bool ContributorEditUsesTurbo { get; init; }
Source
Gets a value indicating whether the contributor edit link should stay inside the docs content frame.
Remarks
This follows the same docs-local resolution contract as ContributorSourceUsesTurbo so preview, versioned, and root-mounted docs surfaces all make the same frame-targeting decision.
IsSectionLanding
bool IsSectionLanding { get; init; }
Source
Gets a value indicating whether the current document is a section landing doc.
FeaturedPageGroups
IReadOnlyList<DocLandingFeaturedPageGroupViewModel> FeaturedPageGroups { get; init; }
Source
Gets the curated next-step groups shown by a section landing doc.
HasFeaturedPages
bool HasFeaturedPages { get; }
Source
Gets a value indicating whether any curated section-landing group has visible next-step pages.
SectionGroups
IReadOnlyList<DocSectionGroupViewModel> SectionGroups { get; init; }
Source
Gets the grouped In this section lists shown by a section landing doc.
HasOutline
bool HasOutline { get; }
Source
Gets a value indicating whether the page has an in-page outline to render.
HasWayfinding
bool HasWayfinding { get; }
Source
Gets a value indicating whether the page has any sequence or related-page wayfinding links to render.
DocContributorProvenanceViewModel
SourceView model describing the contributor provenance evidence rendered near the top of a details page.
Label
string Label { get; init; }
Source
Gets the reader-facing provenance strip label.
SourceHref
string? SourceHref { get; init; }
Source
Gets the browser-facing source URL when one exists.
EditHref
string? EditHref { get; init; }
Source
Gets the browser-facing edit URL when one exists.
LastUpdatedUtc
DateTimeOffset? LastUpdatedUtc { get; init; }
Source
Gets the exact UTC timestamp used for contributor freshness when one exists.
IDocHarvester
SourceInterface for harvesting documentation from various sources.
HarvestAsync
Task<IReadOnlyList<DocNode>> HarvestAsync(string rootPath, CancellationToken cancellationToken = default)
Source
Asynchronously scans the specified root path and returns a collection of documentation nodes harvested from sources under that path.
Parameters
rootPathThe filesystem root path to scan for documentation sources.cancellationTokenAn optional token to observe for cancellation requests.
Returns
A collection of DocNode representing the harvested documentation.
DocHarvestHealthStatus
SourceDescribes the overall health of the latest RazorDocs harvest snapshot.
Remarks
Numeric values are a stable public compatibility contract for persisted and serialized representations. Do not remove, reorder, or renumber existing members.
DocHarvesterHealthStatus
SourceDescribes one configured harvester's contribution to a RazorDocs harvest snapshot.
Remarks
Numeric values are a stable public compatibility contract for persisted and serialized representations. Do not remove, reorder, or renumber existing members.
DocHarvestDiagnosticSeverity
SourceDescribes the severity of a structured RazorDocs harvest diagnostic.
Remarks
Numeric values are a stable public compatibility contract for persisted and serialized representations. Do not remove, reorder, or renumber existing members.
DocPublicSection
SourceEnumerates the built-in public documentation sections used by RazorDocs.
Remarks
Numeric values are a stable public compatibility contract for persisted and serialized representations. Do not remove, reorder, or renumber existing members. Presentation order is defined by DocPublicSectionCatalog.OrderedSections, so renderers should not infer UI ordering from enum ordinals.
RazorDocsHarvestFailedException
SourceException thrown by strict RazorDocs startup preflight when every configured harvester fails.
Remarks
The exception message and Summary intentionally contain only redacted harvest-health fields. Repository roots, raw exception messages, stack traces, and diagnostic cause text stay in host logs and are not copied into this public failure contract.
Summary
DocHarvestFailureSummary Summary { get; }
Source
Gets the redacted strict-harvest failure summary.
DocHarvestFailureSummary
SourceRedacted strict-harvest failure summary safe for public exception messages and export output.
Parameters
StatusThe aggregate harvest-health status that triggered strict failure.GeneratedUtcThe timestamp for the cached harvest snapshot generation.TotalHarvestersNumber of configured harvesters in the failed snapshot.SuccessfulHarvestersNumber of harvesters that completed with docs or an intentional empty result.FailedHarvestersNumber of harvesters that failed, timed out, or canceled.TotalDocsNumber of final docs in the failed snapshot.DiagnosticsRedacted diagnostic entries copied from the failed snapshot.
FromSnapshot
DocHarvestFailureSummary FromSnapshot(DocHarvestHealthSnapshot health)
Source
Creates a redacted strict-harvest failure summary from a harvest-health snapshot.
Parameters
healthThe harvest-health snapshot to summarize.
Returns
A redacted summary that omits repository roots, raw exception details, and diagnostic cause text.
DocHarvestFailureDiagnostic
SourceRedacted strict-harvest diagnostic safe for public exception messages and export output.
Parameters
CodeStable diagnostic code for machine-readable branching and tests.SeverityDiagnostic severity copied from the source diagnostic.HarvesterTypeConcrete harvester type when the diagnostic belongs to one harvester.ProblemOperator-facing problem statement.FixSuggested recovery action.
FromDiagnostic
DocHarvestFailureDiagnostic FromDiagnostic(DocHarvestDiagnostic diagnostic)
Source
Creates a redacted strict-harvest diagnostic from a harvest-health diagnostic.
Parameters
diagnosticThe source diagnostic to redact.
Returns
A diagnostic that omits cause text and raw exception details.
RazorDocsVersionArchiveViewModel
SourceView model for the public RazorDocs version archive and degraded entry surface.
Remarks
The same model drives both the dedicated archive page and the degraded route-root recovery surface when no healthy recommended release can be mounted at the stable entry alias. PreviewHref always points at the current source-backed preview surface, while VersionsHref stays on the stable archive URL. Versions preserves the authored catalog order and should be treated as a read-only projection of the resolved catalog state.
Heading
string Heading { get; init; }
Source
Gets the page heading.
Description
string Description { get; init; }
Source
Gets the orientation copy shown above the archive list.
AvailabilityMessage
string? AvailabilityMessage { get; init; }
Source
Gets optional explanatory copy shown when the stable route-root alias cannot mount a recommended released tree.
Remarks
This is typically null on the dedicated archive page and populated only for the degraded route-root recovery experience.
PreviewHref
string PreviewHref { get; init; }
Source
Gets the live preview docs URL.
Remarks
This points at the configured source-backed preview surface, such as /docs/next for the default route family or /foo/bar/next for a custom one.
VersionsHref
string VersionsHref { get; init; }
Source
Gets the stable archive URL.
Versions
IReadOnlyList<RazorDocsVersionArchiveEntryViewModel> Versions { get; init; }
Source
Gets the available published versions shown in the archive.
RazorDocsVersionArchiveEntryViewModel
SourceRepresents one release entry in the public RazorDocs version archive.
Remarks
Entries may describe either a healthy exact-version tree with an Href target or an unavailable release that should remain visible in the archive with an explanatory availability message. IsRecommended identifies the exact release currently mirrored at the stable route-root alias, while IsAvailable controls whether the entry can link directly to that exact version. Advisory and support labels are independent: an unavailable or deprecated release may still surface an advisory, and a recommended release may still carry a warning label when the catalog says readers should see one.
Version
string Version { get; init; }
Source
Gets the exact published version identifier.
Label
string Label { get; init; }
Source
Gets the reader-facing label.
Summary
string? Summary { get; init; }
Source
Gets optional summary copy for the release.
Href
string? Href { get; init; }
Source
Gets the exact-version URL when the release is available.
Remarks
This is null when IsAvailable is false and the archive should render the release as informational-only.
IsRecommended
bool IsRecommended { get; init; }
Source
Gets a value indicating whether this version is the recommended stable alias target.
IsAvailable
bool IsAvailable { get; init; }
Source
Gets a value indicating whether the exact-version tree is currently available.
SupportStateLabel
string SupportStateLabel { get; init; }
Source
Gets the human-readable support-state label.
AdvisoryLabel
string? AdvisoryLabel { get; init; }
Source
Gets the human-readable advisory label when a release warning should be surfaced.
Remarks
This is null when no release-level warning badge should be rendered.
AvailabilityMessage
string? AvailabilityMessage { get; init; }
Source
Gets the availability explanation when the release tree is unavailable.
Remarks
This is usually populated only when IsAvailable is false and explains why the exact-version tree could not be mounted or linked.
SearchPageViewModel
SourceDescribes the server-rendered shell for the dedicated docs search workspace.
Parameters
TitleThe primary page heading shown above the workspace controls.OrientationA short orientation sentence that explains what users can discover from the workspace.StarterHintHelper copy shown in the starter state before a query or filter is applied.SearchPlaceholderPlaceholder text for the advanced search input.SuggestedQueriesStarter-state suggestions rendered as clickable chips. Empty lists are allowed, but the shell is designed around a curated set of useful first queries.FailureFallbackLinksOrdered recovery links shown when the search runtime or index cannot be loaded. Include at least one non-search path that still helps users continue through the docs set.
Remarks
This model is rendered before the client-side search index is available so the page can show stable loading, starter, and failure states even when the search payload is slow or unavailable. All members are required and should be supplied as non-null values. The list properties render in the order provided. Use SearchPageViewModel for the server-rendered shell contract and recovery guidance, not for live search results or client-side facet state. Callers should prefer empty lists over null for SuggestedQueries and FailureFallbackLinks. Suggested queries and fallback links are displayed in the supplied order, so place the highest-signal actions first. Avoid relying on client-side mutation of this model after render, and avoid using external absolute URLs in SearchPageFallbackLink.Href because the shell assumes app-relative navigation semantics.
SearchPageFallbackLink
SourceRepresents one server-rendered recovery action shown when docs search cannot be initialized.
Parameters
TitleShort, action-oriented label used as the visible link title.HrefThe app-relative destination URL to open when the user follows the recovery action.DescriptionSupporting context that explains what the destination contains and why it helps recover from the failed search flow.UsesDocsFrameA value indicating whether the destination should stay inside the docs content frame. Set this totrueonly when the destination is known to be another docs page rather than a top-level recovery surface such as the docs home or version archive.
Remarks
These links are rendered before the client search payload is available, so each entry should be complete enough to stand on its own. UsesDocsFrame determines whether the destination should continue navigating inside the docs content frame or escalate to a top-level page navigation. Keep Href app-relative and already URL-safe, and assume the UI will HTML-escape the visible text in Title and Description. Prefer concise copy that fits comfortably in a compact recovery card, and do not depend on client search indexing to make the destination discoverable.
RazorDocsHarvestHealthResponse
SourceRedacted operator-facing RazorDocs harvest health response shared by the HTML and JSON health surfaces.
Remarks
This contract intentionally omits repository roots, diagnostic cause text, raw exception messages, stack traces, and other host-local details. Use DocAggregator.GetHarvestHealthAsync(System.Threading.CancellationToken) for server-side inspection when trusted code needs the full snapshot.
FromSnapshot
RazorDocsHarvestHealthResponse FromSnapshot(DocHarvestHealthSnapshot health)
Source
Creates a redacted response from the full server-side harvest health snapshot.
Parameters
healthThe server-side harvest health snapshot.
Returns
A response that is safe to serialize to clients.
Status
string Status { get; init; }
Source
Gets the aggregate harvest status name.
GeneratedUtc
DateTimeOffset GeneratedUtc { get; init; }
Source
Gets the UTC timestamp when the cached harvest snapshot was generated.
Verification
RazorDocsHarvestHealthVerification Verification { get; init; }
Source
Gets the machine-checkable verification rollup for the response.
TotalHarvesters
int TotalHarvesters { get; init; }
Source
Gets the number of configured harvesters in the snapshot.
SuccessfulHarvesters
int SuccessfulHarvesters { get; init; }
Source
Gets the number of harvesters that completed with docs or a valid empty result.
FailedHarvesters
int FailedHarvesters { get; init; }
Source
Gets the number of harvesters that failed, timed out, or canceled.
TotalDocs
int TotalDocs { get; init; }
Source
Gets the number of documentation nodes published by the final cached docs snapshot.
Harvesters
IReadOnlyList<RazorDocsHarvesterHealthResponse> Harvesters { get; init; }
Source
Gets the per-harvester redacted health entries.
Diagnostics
IReadOnlyList<RazorDocsHarvestDiagnosticResponse> Diagnostics { get; init; }
Source
Gets redacted diagnostic entries for failed, degraded, or noteworthy states.
RazorDocsHarvestHealthVerification
SourceMachine-checkable verification rollup for a RazorDocs harvest health response.
Ok
bool Ok { get; init; }
Source
Gets a value indicating whether the harvest state should pass local or CI verification.
HttpStatusCode
int HttpStatusCode { get; init; }
Source
Gets the HTTP status code RazorDocs uses for this response.
RazorDocsHarvesterHealthResponse
SourceRedacted per-harvester health entry in the operator-facing harvest health response.
HarvesterType
string HarvesterType { get; init; }
Source
Gets the concrete harvester type name.
Status
string Status { get; init; }
Source
Gets the harvester status name.
DocCount
int DocCount { get; init; }
Source
Gets the number of documentation nodes returned by the harvester before RazorDocs post-processing.
Diagnostic
RazorDocsHarvestDiagnosticResponse? Diagnostic { get; init; }
Source
Gets the redacted diagnostic explaining a failed, timed-out, or canceled harvester.
RazorDocsHarvestDiagnosticResponse
SourceRedacted diagnostic entry in the operator-facing harvest health response.
Code
string Code { get; init; }
Source
Gets the stable diagnostic code.
Severity
string Severity { get; init; }
Source
Gets the diagnostic severity name.
HarvesterType
string? HarvesterType { get; init; }
Source
Gets the concrete harvester type when the diagnostic belongs to one harvester.
Problem
string Problem { get; init; }
Source
Gets the operator-facing problem statement.
Fix
string Fix { get; init; }
Source
Gets the suggested operator or docs-author recovery action.
DocPublicSectionCatalog
SourceDefines the canonical public-section labels, slugs, purpose copy, and alias lookup rules used by RazorDocs.
GetLabel
string GetLabel(DocPublicSection section)
Source
Gets the canonical display label for the specified public section.
Parameters
sectionThe section whose label should be returned.
Returns
The reader-facing label, such as Start Here or API Reference.
GetSlug
string GetSlug(DocPublicSection section)
Source
Gets the canonical stable route slug for the specified public section.
Parameters
sectionThe section whose slug should be returned.
Returns
A lower-case hyphenated slug suitable for {DocsRootPath}/sections/{slug} routes.
GetPurpose
string GetPurpose(DocPublicSection section)
Source
Gets the short purpose statement used to explain why a public section exists.
Parameters
sectionThe section whose purpose copy should be returned.
Returns
The summary text shown in section-first navigation surfaces.
GetHref
2 overloads
string GetHref(DocPublicSection section)
Source
Gets the default stable public route for the specified section.
Parameters
sectionThe section whose href should be returned.
Returns
The default /docs/sections/{slug} route for the section.
Remarks
This overload always roots the returned href at the default /docs surface. Callers that are rendering links on the current live surface should prefer GetHref(DocPublicSection, string) so custom route roots and preview roots are honored. The route slug is always produced by GetSlug(DocPublicSection).
string GetHref(DocPublicSection section, string docsRootPath)
Source
Gets the canonical public-section route rooted at the caller's current docs surface.
Parameters
sectionThe section whose href should be returned.docsRootPathThe pre-normalized, app-relative docs root path to anchor the section route under. Callers are expected to pass the validated live docs root fromRazorDocsRoutingOptions.DocsRootPathorServices.DocsUrlBuilder.CurrentDocsRootPath, not an arbitrary or unvalidated value.
Returns
The canonical {docsRootPath}/sections/{slug} route for the section, or /sections/{slug} when docsRootPath is exactly /.
Remarks
This overload exists for mounted live docs surfaces such as /docs/next or root-mounted docs at /. It special-cases / so root-mounted hosts emit /sections/{slug} instead of //sections/{slug}. The slug portion is always derived from GetSlug(DocPublicSection). Passing a non-normalized value such as /docs/ can produce incorrect hard-coded links, so callers should normalize and validate docsRootPath before invoking this overload.
TryResolve
bool TryResolve(string? value, out DocPublicSection section)
Source
Resolves an authored section value using canonical labels, canonical slugs, or known aliases.
Parameters
valueThe authored value to resolve.sectionWhen this method returnstrue, contains the resolved public section.
Returns
true when value matches a known label, slug, or alias after normalization; otherwise, false.
Remarks
Resolution is case-insensitive and ignores surrounding whitespace plus non-alphanumeric separators so values such as Start Here, start-here, and start_here all resolve to the same section.
TryResolveSlug
bool TryResolveSlug(string? slug, out DocPublicSection section)
Source
Resolves only canonical section-route slugs for /docs/sections/{slug} URLs.
Parameters
slugThe incoming route slug to resolve.sectionWhen this method returnstrue, contains the resolved public section.
Returns
true when slug matches one canonical section slug after trimming and case-normalization; otherwise, false.
Remarks
Unlike TryResolve, this method does not accept labels or aliases. Callers that want to support legacy or user-friendly alias inputs should resolve them separately and redirect to GetHref(DocPublicSection).
BuildLookup
IReadOnlyDictionary<string, DocPublicSection> BuildLookup()
Source
Builds the lookup table used for authored metadata values that may use labels, slugs, or aliases.
Returns
A normalized dictionary that maps authored section identifiers to their canonical section enum.
BuildSlugLookup
IReadOnlyDictionary<string, DocPublicSection> BuildSlugLookup()
Source
Builds the lookup table used for canonical section-route slugs.
Returns
A normalized dictionary that accepts only canonical slugs for section-route resolution.
NormalizeKey
string NormalizeKey(string? value)
Source
Normalizes authored section metadata so labels, slugs, and aliases can share one lookup table.
Parameters
valueThe authored value to normalize.
Returns
A lowercase alphanumeric key, or an empty string when value is blank.
NormalizeSlug
string NormalizeSlug(string? value)
Source
Normalizes an incoming section-route slug while preserving the canonical hyphenated slug contract.
Parameters
valueThe incoming route slug.
Returns
The trimmed lowercase slug, or an empty string when value is blank.
OrderedSections
IReadOnlyList<DocPublicSection> OrderedSections { get; }
Source
Gets the public sections in their intended presentation order for docs home and sidebar surfaces.
Definition
SourceDescribes one built-in public section, including its canonical display label, stable route slug, and accepted aliases.