Skip to content

Keep MiniPdf READMEs .NET-only and document practical usage - #215

Merged
shps951023 merged 1 commit into
mainfrom
docs/dotnet-only-readme
Nov 17, 2026
Merged

shps951023 merged 1 commit into
mainfrom
docs/dotnet-only-readme

Conversation

@shps951023

Copy link
Copy Markdown
Member

Summary

Complete the documentation follow-up to #214: keep MiniPdf's README and all six translated portal READMEs focused exclusively on the .NET implementation. Remove the remaining language-selection rows, non-.NET documentation links, and cross-language visual-result rows. The corresponding quick starts and visual links are now published in the five independent PdfLibrarys repositories, including 30 translated language quick-start documents.

Add .NET examples for XLSX/DOCX/PPTX files, PDF byte arrays, caller-owned streams, Excel sheet selection and layout, Word page size and margins, opt-in low-memory XLSX conversion, licensed font registration, and CLI conversion. Document format-specific option scope, memory/storage restrictions, and process-wide font registration. Update the library/CLI guide links to the current repository and retain only .NET documentation here.

No application source, tests, workflows, or renderer behavior is changed. Existing local development branches are preserved.

Validation

  • dotnet run --project ReadmeExamples.csproj --configuration Release in an isolated temporary console project referencing the actual MiniPdf source - passed. All six C# code blocks were extracted verbatim from the updated README, compiled, and executed with local XLSX/DOCX/PPTX inputs and a locally installed licensed font.
  • dotnet D:\git\MiniPdf-migration\src\MiniPdf.Cli\bin\Release\net9.0\MiniPdf.Cli.dll report.docx -o cli-report.pdf - passed.
  • dotnet D:\git\MiniPdf-migration\src\MiniPdf.Cli\bin\Release\net9.0\MiniPdf.Cli.dll workbook.xlsx -o cli-workbook.pdf --compress - passed.
  • dotnet D:\git\MiniPdf-migration\src\MiniPdf.Cli\bin\Release\net9.0\MiniPdf.Cli.dll slides.pptx -o cli-slides.pdf - passed.
  • dotnet D:\git\MiniPdf-migration\src\MiniPdf.Cli\bin\Release\net9.0\MiniPdf.Cli.dll --help - passed.
  • Strictly parsed and decoded all 11 generated PDFs with pypdf.PdfReader(..., strict=True) - passed. Verified A4 dimensions (595.28 x 841.89 points), landscape sheet output, selected-sheet text, and low-memory output content.
  • README local-link checks across all six repositories - passed, 44 README files. All six translated .NET READMEs contain the same six C# examples; language quick starts link to their own repository's English guide and license.
  • git diff --check in every changed repository - passed.
  • git diff --exit-code -- src tests scripts .github in MiniPdf - passed, confirming documentation-only changes. Full renderer unit tests and visual benchmarks were not rerun because rendering behavior is unchanged. Package installation commands were not executed globally.

Validation PDFs, test font copies, and temporary console code are not included in this PR or any language repository.

Checklist

  • The change is focused and does not include unrelated formatting or generated files.
  • New or changed behavior has automated test coverage where practical.
  • Relevant .NET checks pass.
  • Public API and compatibility effects are documented.
  • Security implications and untrusted-input behavior were considered.
  • I have the right to submit every added source file, fixture, font, image, and other asset under its stated license.
  • Third-party and generated material includes its source and license.
  • Test documents contain no confidential information or personal data.
  • User-facing documentation is updated, including translated README files when the English README changed.
  • Large benchmark outputs are attached or stored as CI artifacts unless they are required canonical evidence.

Move remaining language portal content and six translated quick starts per language into the independent PdfLibrarys repositories. Expand the .NET README with file/byte-array/stream conversion, XLSX sheet/layout options, DOCX page geometry, low-memory conversion, font registration, and CLI examples.

Validation: all six extracted C# examples and four CLI examples execute successfully; 11 PDFs parse strictly and A4/landscape/selected-sheet/low-memory content checks pass. All 44 README local links validate. No application source is changed.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings November 17, 2026 01:59
@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Explain Change →

Caution

Review failed

The pull request is closed.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues block this documentation-focused update.

No open issues 🎉

What changed in this PR

This documentation-only follow-up to #214 focuses MiniPdf’s READMEs on the retained .NET implementation and expands practical usage guidance. No application code, tests, workflows, or rendering behavior changes.

Changes:

  • Remove non-.NET implementation links and cross-language benchmark rows from the English and six translated portal READMEs.
  • Add examples for file and stream conversion, layout options, low-memory XLSX processing, font registration, and CLI usage.
  • Refresh repository links and clarify Microsoft 365’s primary and LibreOffice’s auxiliary benchmark roles.
File Description
README.md Focuses on .NET and adds practical examples and usage restrictions.
documents/​README.zh-TW.md Removes non-.NET references and adds shared usage examples.
documents/​README.zh-CN.md Removes non-.NET references and adds shared usage examples.
documents/​README.nuget.md Updates repository links, imports, and benchmark reference descriptions.
documents/​README.nuget.cli.md Updates source, badge, and license links to the current repository.
documents/​README.ko.md Removes non-.NET references and adds shared usage examples.
documents/​README.ja.md Removes non-.NET references and adds shared usage examples.
documents/​README.it.md Removes non-.NET references and adds shared usage examples.
documents/​README.fr.md Removes non-.NET references and adds shared usage examples.

Review effort: Balanced

@shps951023
shps951023 merged commit 52e9aa0 into main Nov 17, 2026
3 of 5 checks passed
@shps951023
shps951023 deleted the docs/dotnet-only-readme branch November 17, 2026 03:54
shps951023 added a commit that referenced this pull request Nov 17, 2026
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.

2 participants