Repository navigation
Check generated documentation with MDDoc - #30
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues block the changes adding a CI check for generated README consistency.
No open issues 🎉
What changed in this PR
Adds a CI check to keep the generated README aligned with the coding standard’s source and Composer requirements.
Changes:
- Adds MDDoc as a development dependency, configures Composer autoloading, and runs its dry run in the PHP 8.5 CI job.
- Uses the installed Slevomat README for link generation instead of fetching the upstream branch.
- Regenerates the README with updated requirements and corrected code examples.
| File | Description |
|---|---|
tools/inherited-rules.php |
Reads the installed Slevomat README and reports read failures. |
README.md |
Updates requirements and fixes example syntax. |
composer.json |
Adds the MDDoc development dependency. |
.mddoc.xml |
Switches documentation generation to Composer autoloading. |
.github/workflows/ci.yml |
Checks generated documentation on PHP 8.5. |
Review effort: Balanced
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.
The README can drift from the source and Composer requirements because its generator is not installed or checked in continuous integration.
Add MDDoc as a development dependency and run its dry run in the PHP 8.5 job. Update the autoloader configuration and regenerate the README. Read Slevomat's installed README when generating links, so the check does not depend on a live copy of another branch.
Validation: generated the README and ran the MDDoc dry run. Confirmed it rejects a stale README. Ran
make testand Composer validation on PHP 8.5.