Generate downloadable DocFX API documentation PDF - #134
Conversation
Adding CLAUDE.md with task information for AI processing. This file will be removed when the task is complete. Issue: #24
- Add docfx.json with PDF generation support - Update toc.yml to enable PDF generation - Create custom publish script for PDF documentation - Update CI workflow to use modern DocFX with PDF capabilities - Enable PDF download button in documentation site 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
|
Resolve conflicts, and make sure everything is done perfectly up to the highest standards. |
|
🤖 AI Work Session Started Starting automated work session at 2026-09-25T15:44:37.683Z The PR has been converted to draft mode while work is in progress. This comment marks the beginning of an AI work session. Please wait for the session to finish, and provide your feedback. Runtime: solve |
|
The latest |
|
All GitHub Actions checks on commit |
🤖 Solution Draft LogThis log file contains the complete execution trace of the AI solution draft process. 💰 Cost estimation:
📊 Context and tokens usage:
Total: (188.5K + 16.0M cached) input tokens, 40.0K output tokens, $7.757907 cost 🤖 Models used:
📎 Log file uploaded as Gist (6043KB)Now working session is ended, feel free to review and add any feedback on the solution draft. |
🎉 Auto-mergedThis pull request has been automatically merged by hive-mind.
Auto-merged by hive-mind with --auto-merge flag |
Summary
Platform.Interfaces.Documentation.pdfalongside the HTML site.maindocumentation pipeline and remove the draft's unused root DocFX files and duplicate publisher. The existingPlatform.Interfaces.pdfsource-code PDF and Pages publisher remain in place.0.5.3with updated release notes.Reproduction and regression coverage
Before this change,
docfx docfx.json --warningsAsErrorsproduced no documentation PDF. The site validator also accepted output with no documentation PDF; the new missing-PDF test failed against that behavior before the fix. The validator tests now reject a missing PDF, a file without a PDF header, and a home page without the PDF link.The configured DocFX 2.80.1 build now creates a 21-page PDF containing the home page and API topics, including
IFactoryandIProvider. Its distinct filename prevents a collision with the existing source-code PDF when the CI artifacts are assembled.Verification
node --test .github/scripts/*.test.mjs— 40 passed..github/scripts/validate-csharp-package.shwith .NET 8 — warning-free build, 2 tests passed, and the0.5.3package validated with embedded symbols.docfx docfx.json --warningsAsErrors— 0 warnings and 0 errors; the generated site passedvalidate-csharp-docs.sh.git diff --check origin/main...HEAD— passed.Screenshot
Release credential
The latest
mainC# run failed when NuGet.org rejected the package push with HTTP 403: the repositoryNUGET_TOKENis invalid, expired, or lacks package permission. A maintainer needs to correct that secret before the0.5.3release can publish to NuGet.org.Resolves #24