Project cleanup and comprehensive documentation improvements #65
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.
This PR addresses comprehensive project cleanup and documentation improvements to make the json5-kotlin library more accessible and easier to understand for contributors and users.
Key Improvements
Documentation Enhancements
JSON5.parse()
instead of outdated references)JSON5Exception
andSerializationException
Code Examples & Testing
Project Configuration
Build & Development
Before/After Examples
Before:
After:
The documentation now provides accurate, practical examples with proper error handling that users can copy and use directly in their projects.
Testing
./gradlew build
)./gradlew check
)./gradlew formatKotlin
)./gradlew :app:run
)Fixes #64.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.