Skip to content

Check generated documentation with MDDoc - #30

Merged
donatj merged 2 commits into
masterfrom
chore/mddoc-ci
Nov 3, 2026
Merged

donatj merged 2 commits into
masterfrom
chore/mddoc-ci

Conversation

@donatj

@donatj donatj commented Nov 3, 2026

Copy link
Copy Markdown
Member

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 test and Composer validation on PHP 8.5.

@donatj
donatj marked this pull request as ready for review November 3, 2026 10:00
Copilot AI balanced review requested due to automatic review settings November 3, 2026 10:00

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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

@donatj
donatj merged commit 730fa3e into master Nov 3, 2026
17 checks passed
@donatj
donatj deleted the chore/mddoc-ci branch November 3, 2026 10:02
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.

2 participants