docs: add comprehensive multi-language documentation (en-US + pt-BR)#61
Merged
Merged
Conversation
- 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>
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:
|
Owner
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
|
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 the metar-decoder repository.
Documentation Changes
README files:
README.mdin English (en-US) as the default languageREADME.pt-br.mdwith full Portuguese (pt-BR) translationDetailed guides (
docs/folder):docs/en-US/usage-guide.md— Comprehensive usage guide with METAR and TAF examples, unit conversion, parsing modes, error handlingdocs/en-US/api-reference.md— Complete API reference for all public classes, properties, methods, and enumerationsdocs/pt-BR/guia-de-uso.md— Portuguese usage guidedocs/pt-BR/referencia-api.md— Portuguese API referenceNuGet 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 linkssrc/Taf.Decoder/Assets/nuget-readme.md— Taf.Decoder package README with quick start, features, evolution examples, and repository links.csprojfiles to reference the new NuGet readme filesXML documentation improvements:
SurfaceWind,Visibility,WeatherPhenomenon,ValueCavoksummary onDecodedMetarandDecodedTafTemperature.cs("Hur" → "Hour")SetDirectionVariations,AddTypeValue.Unitenum documentationBuild
dotnet build MetarDecoder.sln --configuration Releasepasses successfullyLink to Devin session: https://app.devin.ai/sessions/e7852e5f759e4ba9a2ed414a0f8cc7e6
Requested by: @afonsoft