-
Notifications
You must be signed in to change notification settings - Fork 5
updated docs #25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
updated docs #25
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates the documentation for the json-everything library to reflect changes from a major version update (likely v8.x based on the content). The changes include restructuring documentation organization, updating API examples, removing deprecated content, and adding new documentation for the updated custom keywords API.
Key Changes:
- Updated theme version from 5.6.1 to 7.2.4 and improved development tooling (live reload, platform detection)
- Reorganized documentation ordering with zero-padded numbering for better sorting
- Replaced old custom vocabulary documentation with new custom keywords documentation reflecting API changes
- Updated code examples to use
JsonElementinstead ofJsonNodethroughout - Removed deprecated documentation (legacy output formats, old configuration examples)
Reviewed changes
Copilot reviewed 49 out of 50 changed files in this pull request and generated 13 comments.
Show a summary per file
| File | Description |
|---|---|
| run.bat | Added --livereload flag for improved development experience |
| jekyll-theme-chirpy.gemspec | Updated theme version from 5.6.1 to 7.2.4 |
| Gemfile | Updated platform detection from :mingw to :windows and commented out wdm dependency |
| _docs/schema/vocabs/*.md | Updated order fields from "01.8.x" to "01.09.x" for consistent sorting |
| _docs/schema/vocabs/openapi.md | Changed API call from Vocabularies.Register() to MetaSchemas.Register() |
| _docs/schema/vocabs.md | Updated vocabulary documentation and removed detailed custom keyword implementation (now in separate file) |
| _docs/schema/serialization.md | Updated examples to show both ValidatingJsonConverter and GenerativeValidatingJsonConverter with clearer configuration |
| _docs/schema/schemagen/*.md | Updated order fields from "01.5.x" to "01.06.x" for consistent sorting |
| _docs/schema/examples/*.md | Updated order fields from "01.4.x" to "01.05.x" for consistent sorting |
| _docs/schema/examples/version-selection.md | Changed from builder-based examples to JSON parsing examples using JsonElement |
| _docs/schema/examples/managing-options.md | Removed (deprecated content about options configuration) |
| _docs/schema/examples/legacy-output.md | Removed (deprecated legacy output format documentation) |
| _docs/schema/examples/external-schemas.md | Updated to reflect new build-time schema registration instead of manual registry management |
| _docs/schema/examples/custom-vocabs.md | Removed (replaced by new custom-keywords.md) |
| _docs/schema/examples/custom-keywords.md | New file documenting the updated IKeywordHandler API for creating custom keywords |
| _docs/schema/custom-keywords.md | New file providing comprehensive guide for defining and using custom keywords with the new API |
| _docs/schema/datagen/*.md | Updated order fields from "01.7.x" to "01.06.x" (note: this creates overlap with schemagen) |
| _docs/schema/codegen/*.md | Updated order fields from "01.6.x" to "01.07.x" for consistent sorting |
| _docs/schema/basics.md | Major updates to reflect new two-phase build/evaluate approach, JsonElement usage, and dialect-based configuration |
| _docs/schema/close.md | Updated order field from "01.9" to "01.10" |
| _docs/pointer/basics.md | Removed LINQ expression documentation for pointer creation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Depends on json-everything/json-everything#952