Skip to content

docs: add comprehensive multi-language documentation (en-US + pt-BR)#47

Merged
afonsoft merged 1 commit into
mainfrom
devin/1777922458-docs-multilang-update
May 10, 2026
Merged

docs: add comprehensive multi-language documentation (en-US + pt-BR)#47
afonsoft merged 1 commit into
mainfrom
devin/1777922458-docs-multilang-update

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you successfully ran tests with your changes locally?

Summary

Complete multi-language documentation overhaul for QRCoder.Core.

README files

  • Rewrote README.md in 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 guide
  • Created README.pt-br.md with full Portuguese (pt-BR) translation

NuGet package README

  • Rewrote QRCoder.Core/Assets/nuget-readme.md in English with:
    • Quick start example
    • Output formats table with inline code examples
    • Multiple formats example
    • Payload types examples (WiFi, URL, Email, Phone, vCard)
    • Error correction levels reference
    • Links to repository, usage guide, and issues

XML documentation improvements

Improved class-level /// <summary> on all public types:

  • Abstractions: AbstractQRCode — lifecycle management and QRCodeData access
  • Models: QRCodeData — module matrix storage, QRR serialization; Size — rendering dimensions
  • Renderers: QRCode, PngByteQRCode, SvgQRCode, ArtQRCode, AsciiQRCode, Base64QRCode, PdfByteQRCode, PostscriptQRCode, SKBitmapByteQRCode
  • Exceptions: DataTooLongException — payload capacity exceeded
  • Extensions: SKColorExtensions — hex conversion; StringValueAttribute, CustomExtensions

Build

  • dotnet build QRCoder.Core.sln --configuration Release passes 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

- 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>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@sonarqubecloud
Copy link
Copy Markdown

@afonsoft afonsoft merged commit b04c41f into main May 10, 2026
11 of 13 checks passed
@afonsoft afonsoft deleted the devin/1777922458-docs-multilang-update branch May 10, 2026 15:45
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.

1 participant