Skip to content

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

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

docs: add comprehensive multi-language documentation (en-US + pt-BR)#61
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 the metar-decoder repository.

Documentation Changes

README files:

  • Rewrote README.md in English (en-US) as the default language
  • Created README.pt-br.md with full Portuguese (pt-BR) translation

Detailed guides (docs/ folder):

  • docs/en-US/usage-guide.md — Comprehensive usage guide with METAR and TAF examples, unit conversion, parsing modes, error handling
  • docs/en-US/api-reference.md — Complete API reference for all public classes, properties, methods, and enumerations
  • docs/pt-BR/guia-de-uso.md — Portuguese usage guide
  • docs/pt-BR/referencia-api.md — Portuguese API reference

NuGet package READMEs (en-US only):

  • src/Metar.Decoder/Assets/nuget-readme.md — Metar.Decoder package README with quick start, features, unit conversion examples, and repository links
  • src/Taf.Decoder/Assets/nuget-readme.md — Taf.Decoder package README with quick start, features, evolution examples, and repository links
  • Updated both .csproj files to reference the new NuGet readme files

XML documentation improvements:

  • Improved class-level summaries on SurfaceWind, Visibility, WeatherPhenomenon, Value
  • Added missing Cavok summary on DecodedMetar and DecodedTaf
  • Fixed typo in Temperature.cs ("Hur" → "Hour")
  • Improved method documentation on SetDirectionVariations, AddType
  • Enhanced Value.Unit enum documentation

Build

  • dotnet build MetarDecoder.sln --configuration Release passes successfully

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
- Create docs/en-US/usage-guide.md with detailed usage examples
- Create docs/en-US/api-reference.md with complete API documentation
- Create docs/pt-BR/guia-de-uso.md with Portuguese usage guide
- Create docs/pt-BR/referencia-api.md with Portuguese API reference
- Create NuGet-specific readme files (en-US) for Metar.Decoder and Taf.Decoder
- Update csproj files to reference NuGet readme files
- Improve XML documentation summaries on public classes and methods
- Fix typo in Temperature.cs Hour summary

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

@afonsoft
Copy link
Copy Markdown
Owner

afonsoft commented May 4, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
🔚 Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 4, 2026

Quality Gate Failed Quality Gate failed

Failed conditions
19.2% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

@afonsoft afonsoft merged commit b4b8348 into main May 6, 2026
16 of 19 checks passed
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