Cephalon.ReferenceDocs
Maturity:
M2· Ownership: cephalon-managed · Family:scaffolding-and-tooling· See audit, matrix.
Cephalon.ReferenceDocs is the optional repo-local publishing tool that turns compiled assemblies plus XML comments into browsable API reference output.
Stable public surface:
ReferenceDocsApplicationReferenceDocsGeneratorReferenceDocsRequestRenderedReferenceDocsReferenceDocFileReferenceDocsWriter
Internal generation helpers:
DocumentationLoadContextReferenceBrowserRenderer
What it owns
Section titled “What it owns”- loading compiled assemblies and XML docs for documentation generation
- Markdown page generation for assemblies, namespaces, types, and members
- browser UI rendering assets and machine-readable manifest generation
- filesystem writing for generated reference docs
Main implementation surfaces
Section titled “Main implementation surfaces”Generation/ReferenceDocsGenerator.csGeneration/ReferenceDocsRequest.csGeneration/ReferenceBrowserRenderer.csGeneration/DocumentationLoadContext.csGeneration/RenderedReferenceDocs.csGeneration/ReferenceDocFile.csIO/ReferenceDocsWriter.csReferenceDocsApplication.cs
Source structure
Section titled “Source structure”GenerationIO
How it fits
Section titled “How it fits”This package is not the source of truth for Cephalon’s product documentation. Hand-authored .md files under README.md and docs/ explain what Cephalon is, what it ships, and how to adopt it. Cephalon.ReferenceDocs exists so the same XML comments that power IntelliSense can also be published as optional reference output when the repository wants a browsable API artifact.
The ASP.NET Core host can then serve that generated output, and the CLI can publish, validate, and open it.
For package-surface hardening, the reusable library contract stays centered on request/generate/write flows. Assembly-load plumbing and browser-asset rendering stay internal so future docs-site changes do not widen the public API unnecessarily.