Repository navigation
docs: generate API metadata from Release assemblies so extension members appear - #34
Merged
Merged
Conversation
DocFX source extraction drops members declared in C# 14 extension blocks (the containing class is emitted with no children). Read the built assemblies instead, as logging-extensions does, and have BuildDocs build the documented projects in Release first. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jy23TCq1bZkdPV2GRWfspU
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The configuration, automated build target, and contributor documentation consistently implement the assembly-based metadata workflow.
0 open findings
What changed in this PR
Updates DocFX to generate complete API metadata from Release assemblies, including C# 14 extension members.
Changes:
- Uses the compiled library assembly for metadata.
- Prebuilds the library through
BuildDocs. - Documents the required manual workflow.
| File | Description |
|---|---|
docfx.json |
Reads API metadata from the Release DLL. |
_atom/IBuild.cs |
Builds the library before DocFX runs. |
AGENTS.md |
Documents the Release-build prerequisite. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Dec · project thread
Before: DocFX built API metadata from the C# source. That drops members declared in C# 14
extension(...)blocks, so the API reference was missing them.After: every extension-block member appears in the API reference, with its summary and remarks. This is the same approach logging-extensions already uses.
How:
src/<Project>/bin/Release/net10.0/<Project>.dll) instead of the csproj files.BuildDocspasses those projects toBuildDocFxDocsas its prebuild list, so they are built in Release before docfx runs.There are two trade-offs: assembly metadata has no "View source" links, and static extension properties render as
get_X()accessors.I checked this locally. From a clean tree,
BuildDocssucceeds, and a script confirmed every public extension-block member appears in the generatedapi/*.yml.🤖 Generated with Claude Code
https://claude.ai/code/session_01Jy23TCq1bZkdPV2GRWfspU
Generated by Claude Code