Skip to content

Generate downloadable DocFX API documentation PDF - #134

Merged
konard merged 6 commits into
mainfrom
issue-24-035e07eb
Sep 25, 2026
Merged

konard merged 6 commits into
mainfrom
issue-24-035e07eb

Conversation

@konard

@konard konard commented Sep 10, 2025 •

Copy link
Copy Markdown
Member

Summary

  • Enable DocFX PDF generation with the modern template and publish Platform.Interfaces.Documentation.pdf alongside the HTML site.
  • Link the documentation PDF from the home page and require the generated PDF, its file signature, and the home-page link during site validation.
  • Merge the current main documentation pipeline and remove the draft's unused root DocFX files and duplicate publisher. The existing Platform.Interfaces.pdf source-code PDF and Pages publisher remain in place.
  • Prepare C# package version 0.5.3 with updated release notes.

Reproduction and regression coverage

Before this change, docfx docfx.json --warningsAsErrors produced 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 IFactory and IProvider. 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.sh with .NET 8 — warning-free build, 2 tests passed, and the 0.5.3 package validated with embedded symbols.
  • DocFX 2.80.1 with .NET 8: docfx docfx.json --warningsAsErrors — 0 warnings and 0 errors; the generated site passed validate-csharp-docs.sh.
  • PDF content inspection — 21 pages with expected API topics.
  • Browser check — the generated home page shows the documentation PDF link.
  • git diff --check origin/main...HEAD — passed.
  • C# PR run 36158050185 — all required jobs passed, including DocFX PDF generation, site validation before upload and after artifact assembly, and the terminal pipeline gate. CodeQL and README checks passed.

Screenshot

DocFX documentation home page with API PDF link

Release credential

The latest main C# run failed when NuGet.org rejected the package push with HTTP 403: the repository NUGET_TOKEN is invalid, expired, or lacks package permission. A maintainer needs to correct that secret before the 0.5.3 release can publish to NuGet.org.

Resolves #24

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

Issue: #24
@konard konard self-assigned this Sep 10, 2025
konard and others added 2 commits September 10, 2025 18:45
- 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>
@konard konard changed the title [WIP] Configure DocFX to generate PDF with documentation. Configure DocFX to generate PDF with documentation Sep 10, 2025
@konard
konard marked this pull request as ready for review September 10, 2025 15:50
@konard

konard commented Sep 25, 2026

Copy link
Copy Markdown
Member Author

Resolve conflicts, and make sure everything is done perfectly up to the highest standards.

@konard
konard marked this pull request as draft September 25, 2026 15:44
@konard

konard commented Sep 25, 2026

Copy link
Copy Markdown
Member Author

🤖 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 v2.32.0 · tool codex · model gpt-6-sol · task image konard/hive-mind-dind:2.32.0@sha256:f73befa87d04185dfba6329bbb9acc8b8b16f1bbb1b07d68d7b38d28df574020

@konard konard changed the title Configure DocFX to generate PDF with documentation Generate downloadable DocFX API documentation PDF Sep 25, 2026
@konard

konard commented Sep 25, 2026

Copy link
Copy Markdown
Member Author

The latest main C# run failed to publish Platform.Interfaces.0.5.2.nupkg to NuGet.org: the publish job reports HTTP 403, saying the API key is invalid, expired, or lacks package permission. Could a maintainer update NUGET_TOKEN before the 0.5.3 release? The documentation jobs in that run passed; this credential is the remaining release blocker.

@konard
konard marked this pull request as ready for review September 25, 2026 16:06
@konard

konard commented Sep 25, 2026

Copy link
Copy Markdown
Member Author

All GitHub Actions checks on commit 88e17d1 passed, including the C# documentation and final pipeline gate. The Codacy check has remained "in progress" since 2026-09-25 16:01 UTC with only "Codacy is analyzing your code" and no findings or completion result. Could a maintainer check the Codacy integration if it stays pending? I cannot resolve an external check from this branch.

@konard

konard commented Sep 25, 2026

Copy link
Copy Markdown
Member Author

🤖 Solution Draft Log

This log file contains the complete execution trace of the AI solution draft process.

💰 Cost estimation:

  • Model: GPT-6 Sol
  • Provider: OpenAI
  • Public pricing estimate: $7.757907

📊 Context and tokens usage:

  • 188.5K / 200K (94%) input tokens, 40.0K / 128K (31%) output tokens

Total: (188.5K + 16.0M cached) input tokens, 40.0K output tokens, $7.757907 cost

🤖 Models used:

  • Tool: OpenAI Codex
  • Requested: gpt-6-sol
  • Thinking level: xhigh (~31999 tokens)
  • Model: GPT-6 Sol (gpt-6-sol)

📎 Log file uploaded as Gist (6043KB)


Now working session is ended, feel free to review and add any feedback on the solution draft.

@konard
konard merged commit 0951465 into main Sep 25, 2026
16 checks passed
@konard

konard commented Sep 25, 2026

Copy link
Copy Markdown
Member Author

🎉 Auto-merged

This pull request has been automatically merged by hive-mind.

  • All CI checks have passed

Auto-merged by hive-mind with --auto-merge flag

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.

Configure DocFX to generate PDF with documentation.

1 participant