Skip to content

Fix documentation generation with docfx#48

Open
konard wants to merge 3 commits intomainfrom
issue-47-253142db
Open

Fix documentation generation with docfx#48
konard wants to merge 3 commits intomainfrom
issue-47-253142db

Conversation

@konard
Copy link
Copy Markdown
Member

@konard konard commented Sep 11, 2025

Summary

This PR fixes the documentation generation with docfx by addressing several configuration issues:

  • Target Framework Mismatch: Updated docfx.json to use net8 instead of netstandard2.0 to match the actual project target framework
  • Source Directory: Configured docfx to look for .sln files in the correct csharp/ subdirectory
  • Git Branch Reference: Changed branch reference from master to main to match the repository's default branch
  • Local Configuration Files: Added properly configured docfx.json, filter.yml, and toc.yml to the repository instead of downloading them from remote scripts
  • Workflow Updates: Modified GitHub Actions workflows to use local configuration files, eliminating potential configuration mismatches

Test plan

  • Verified documentation generation works locally with docfx docfx.json
  • Confirmed all API documentation files are generated correctly in _site/api/
  • Validated proper filtering of test and benchmark assemblies
  • Tested correct API links in table of contents

The documentation now generates successfully without errors, and the workflows will use consistent, version-controlled configuration files.

🤖 Generated with Claude Code


Resolves #47

Adding CLAUDE.md with task information for AI processing.
This file will be removed when the task is complete.

Issue: #47
@konard konard self-assigned this Sep 11, 2025
konard and others added 2 commits September 11, 2025 09:18
- Add properly configured docfx.json with correct target framework (net8)
- Add filter.yml to exclude test and benchmark assemblies from documentation
- Add toc.yml with correct API documentation links
- Update GitHub Actions workflows to use local config files instead of downloading them
- Fix git branch reference from 'master' to 'main'
- Set correct source directory 'csharp' for .sln files

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@konard konard changed the title [WIP] Fix documentation generation with docfx Fix documentation generation with docfx Sep 11, 2025
@konard konard marked this pull request as ready for review September 11, 2025 06:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix documentation generation with docfx

1 participant