Open
Conversation
Adding CLAUDE.md with task information for AI processing. This file will be removed when the task is complete. Issue: #38
Added docfx.json configuration with Platform.Exceptions xref service to properly resolve cross-references in documentation. - Add docfx.json with xrefService configuration pointing to Platform.Exceptions xrefmap - Configure target framework as net8 to match project settings - Add filter.yml to exclude test projects from documentation - Add toc.yml for proper navigation structure - Ensure Platform.Exceptions.ExtensionRoots types are properly linked in generated docs 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
konard
changed the title
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
1 participant
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.
Summary
Problem
The documentation at https://linksplatform.github.io/Disposables/api/Platform.Disposables.EnsureExtensions.html had broken references to Platform.Exceptions types like
EnsureAlwaysExtensionRootandEnsureOnDebugExtensionRoot. These appeared as plain text instead of proper cross-reference links.Solution
Created a local docfx.json configuration that:
https://linksplatform.github.io/Exceptions/csharp/xrefmap.ymlto resolve external type referencesnet8to match the project configuration (was defaulting tonetstandard2.0)filter.ymlandtoc.ymlfor proper documentation structureFiles Changed
docfx.json- Main DocFX configuration with xrefService setupfilter.yml- Filters out test projects from API documentationtoc.yml- Table of contents configuration for navigationTest Plan
<span class="xref">(ready for xref resolution)The xref resolution will be properly applied when documentation is built by the CI pipeline with internet access to fetch external references.
Fixes #38
🤖 Generated with Claude Code