feat: Upgrade documentation system with auto-generated client API reference - #56
Merged
Conversation
…erence This commit introduces a complete overhaul of the project's documentation site, focusing on automation and improved maintainability. The key change is the implementation of an auto-generation process for the API client reference documentation. A new script (`bin/generate-client-docs.php`) now dynamically creates Markdown pages for `Cloudflare\Endpoints` classes directly from their PHP docblocks. This replaces the previous manual API documentation, which was prone to becoming outdated. Associated changes include: - Migration of the documentation build process from Nuxt Studio, reflected in workflow (`.github/workflows/docs.yml`) and dependency updates. - Restructuring of the `docs/content` directory, introducing a dedicated `2.client` section for the generated API reference. - Updates to `README.md` and `composer.json` to reflect the new documentation publishing location and build commands. This upgrade significantly enhances documentation accuracy and reduces manual maintenance effort.
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
1 participant
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 commit introduces a complete overhaul of the project's documentation site, focusing on automation and improved maintainability.
The key change is the implementation of an auto-generation process for the API client reference documentation. A new script (
bin/generate-client-docs.php) now dynamically creates Markdown pages forCloudflare\Endpointsclasses directly from their PHP docblocks. This replaces the previous manual API documentation, which was prone to becoming outdated.Associated changes include:
.github/workflows/docs.yml) and dependency updates.docs/contentdirectory, introducing a dedicated2.clientsection for the generated API reference.README.mdandcomposer.jsonto reflect the new documentation publishing location and build commands.This upgrade significantly enhances documentation accuracy and reduces manual maintenance effort.