Skip to content

feat: Adding docs#3

Merged
tymondesigns merged 2 commits intomainfrom
feat/docs
Feb 16, 2026
Merged

feat: Adding docs#3
tymondesigns merged 2 commits intomainfrom
feat/docs

Conversation

@tymondesigns
Copy link
Contributor

@tymondesigns tymondesigns commented Feb 16, 2026

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:

  • Introduced a GitHub Actions workflow (.github/workflows/sync-docs.yml) to notify the external documentation repository (cortexphp/docs) whenever documentation in the docs/ directory is updated on the main branch.

Other Minor Improvements:

  • Updated the requirements in the README.md to explicitly mention the need for the JSON PHP extension.

@tymondesigns tymondesigns marked this pull request as ready for review February 16, 2026 12:41
@tymondesigns tymondesigns merged commit 1cfe057 into main Feb 16, 2026
17 checks passed
@tymondesigns tymondesigns deleted the feat/docs branch February 16, 2026 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant