Skip to content

Commit 6bad684

Browse files
authored
docs: add YAML front matter to the SLI API reference docs (#61)
The three docs/api_reference/trellis-api-sli*.md files used bold-markdown headers instead of the YAML front matter (package / namespaces / types / version / last_verified / audience: [llm]) that the Trellis framework reference docs use. Tooling or LLMs that key off audience:[llm] or the types metadata skipped or misclassified these docs relative to the rest of the Trellis reference set. Prepend the standard front matter to all three (additive -- the human-readable **Package** / **Namespace** / **Purpose** lines stay). The docs are auto-packed into each package's trellis/ folder by Directory.Build.targets, so republished packages carry the metadata for every downstream consumer (framework, templates, future consumers). Verified by packing Trellis.ServiceLevelIndicators: the trellis/trellis-api-sli.md entry now begins with the front matter block.
1 parent 88fcdc5 commit 6bad684

3 files changed

Lines changed: 27 additions & 0 deletions

File tree

docs/api_reference/trellis-api-sli-apiversioning.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
package: Trellis.ServiceLevelIndicators.Asp.ApiVersioning
3+
namespaces: [Trellis.ServiceLevelIndicators]
4+
types: [ServiceLevelIndicatorServiceCollectionExtensions, ApiVersionEnrichment, AddApiVersion]
5+
version: v10
6+
last_verified: 2026-06-18
7+
audience: [llm]
8+
---
9+
110
# Trellis.ServiceLevelIndicators.Asp.ApiVersioning — API Reference
211

312
**Package:** `Trellis.ServiceLevelIndicators.Asp.ApiVersioning`

docs/api_reference/trellis-api-sli-asp.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
package: Trellis.ServiceLevelIndicators.Asp
3+
namespaces: [Trellis.ServiceLevelIndicators]
4+
types: [IServiceLevelIndicatorBuilder, ServiceLevelIndicatorCoreServiceCollectionExtensions, ServiceLevelIndicatorServiceCollectionExtensions, ServiceLevelIndicatorApplicationBuilderExtensions, EndpointBuilderExtensions, ServiceLevelIndicatorAttribute, CustomerResourceIdAttribute, MeasureAttribute, CustomerResourceIdMetadata, MeasureMetadata, WebEnrichmentContext, IServiceLevelIndicatorFeature, HttpContextExtensions]
5+
version: v10
6+
last_verified: 2026-06-18
7+
audience: [llm]
8+
---
9+
110
# Trellis.ServiceLevelIndicators.Asp — API Reference
211

312
**Package:** `Trellis.ServiceLevelIndicators.Asp`

docs/api_reference/trellis-api-sli.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
package: Trellis.ServiceLevelIndicators
3+
namespaces: [Trellis.ServiceLevelIndicators]
4+
types: [ServiceLevelIndicator, ServiceLevelIndicatorOptions, MeasuredOperation, SliOutcome, IEnrichmentContext, "IEnrichment<T>", IServiceLevelIndicatorBuilder, ServiceLevelIndicatorMeterProviderBuilderExtensions, AddServiceLevelIndicator, AddServiceLevelIndicatorInstrumentation]
5+
version: v10
6+
last_verified: 2026-06-18
7+
audience: [llm]
8+
---
9+
110
# Trellis.ServiceLevelIndicators — API Reference
211

312
**Package:** `Trellis.ServiceLevelIndicators`

0 commit comments

Comments
 (0)