docs: add comprehensive multi-language documentation (en-US + pt-BR)#47
Merged
Merged
Conversation
- Rewrite README.md in English (en-US) as the default language - Create README.pt-br.md with Portuguese translation - Update NuGet package readme with detailed examples and repository links - Improve XML documentation summaries on all public classes: AbstractQRCode, QRCodeData, Size, DataTooLongException, SKColorExtensions, StringValueAttribute, CustomExtensions, and all 9 renderer classes (QRCode, PngByteQRCode, SvgQRCode, ArtQRCode, AsciiQRCode, Base64QRCode, PdfByteQRCode, PostscriptQRCode, SKBitmapByteQRCode) Co-Authored-By: Afonso Dutra Nogueira Filho <afonsoft@gmail.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
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.



All Submissions:
Changes to Core Features:
Summary
Complete multi-language documentation overhaul for QRCoder.Core.
README files
README.mdin English (en-US) as the default language with comprehensive sections: output formats table, payload types table, quick start, error correction levels, repo structure, CI/CD, and contributing guideREADME.pt-br.mdwith full Portuguese (pt-BR) translationNuGet package README
QRCoder.Core/Assets/nuget-readme.mdin English with:XML documentation improvements
Improved class-level
/// <summary>on all public types:AbstractQRCode— lifecycle management and QRCodeData accessQRCodeData— module matrix storage, QRR serialization;Size— rendering dimensionsQRCode,PngByteQRCode,SvgQRCode,ArtQRCode,AsciiQRCode,Base64QRCode,PdfByteQRCode,PostscriptQRCode,SKBitmapByteQRCodeDataTooLongException— payload capacity exceededSKColorExtensions— hex conversion;StringValueAttribute,CustomExtensionsBuild
dotnet build QRCoder.Core.sln --configuration Releasepasses successfully across all 4 targets (netstandard2.1, net8.0, net10.0, net48)Link to Devin session: https://app.devin.ai/sessions/e7852e5f759e4ba9a2ed414a0f8cc7e6
Requested by: @afonsoft