docs: Format README tables and remove duplicate content#22
Merged
Conversation
- Align markdown tables for better readability - Add blank lines before code blocks for proper rendering - Remove duplicate Examples section - Update License section to reflect current MIT-only license
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README.md documentation to improve formatting consistency and simplify the license section. The changes focus on enhancing readability through better table alignment and whitespace management.
- Reformatted markdown tables for struct-level and field-level attributes with improved alignment
- Added blank lines before code blocks in the config file formats section for better visual separation
- Removed the Examples section and simplified the License section to show only MIT license
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT) | ||
|
|
||
| at your option.# gonfig | ||
| - MIT license ([LICENSE](LICENSE) or https://opensource.org/licenses/MIT) |
There was a problem hiding this comment.
Incomplete sentence fragment. The line starts with '- ' suggesting a list item but lacks proper context. Should either be 'This project is licensed under:' followed by the list item, or be a complete sentence like 'This project is licensed under the MIT license'.
Suggested change
| - MIT license ([LICENSE](LICENSE) or https://opensource.org/licenses/MIT) | |
| This project is licensed under the MIT license ([LICENSE](LICENSE) or https://opensource.org/licenses/MIT). |
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
Test plan