Repository navigation
Keep MiniPdf READMEs .NET-only and document practical usage - #215
Merged
Merged
Conversation
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>
There was a problem hiding this comment.
🟢 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
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
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
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 Releasein 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.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.git diff --checkin every changed repository - passed.git diff --exit-code -- src tests scripts .githubin 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