Merged
Conversation
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.
This pull request introduces a new documentation site for the JSON Repair package, improves the organization and discoverability of documentation, and adds automation for syncing documentation changes. The README is simplified to point users to the new docs, and a GitHub Actions workflow is added to notify the docs repository on updates.
Documentation Overhaul and Site Addition:
Added a comprehensive documentation site in the
docs/directory, including pages for introduction, installation, configuration options, repair examples, logging, and a quick start guide. The site uses a structured navigation and theming for better user experience. [1] [2] [3] [4] [5] [6] [7]Removed detailed configuration and logging instructions from the
README.md, replacing them with a prominent link to the new documentation site for easier maintenance and clarity.Automation and Workflow Improvements:
.github/workflows/sync-docs.yml) to notify the external documentation repository (cortexphp/docs) whenever documentation in thedocs/directory is updated on the main branch.Other Minor Improvements:
README.mdto explicitly mention the need for the JSON PHP extension.