Skip to content

docs: improve documentation generation instructions#789

Merged
mokuzon merged 1 commit intoline:masterfrom
Ayoub-Mabrouk:improve-docs-generation-instructions
Apr 7, 2026
Merged

docs: improve documentation generation instructions#789
mokuzon merged 1 commit intoline:masterfrom
Ayoub-Mabrouk:improve-docs-generation-instructions

Conversation

@Ayoub-Mabrouk
Copy link
Copy Markdown
Contributor

Closes #788

As mentioned in PR #772, contributors need clearer guidance on when and why to regenerate documentation. This PR addresses issue #788.

  1. Add composer docs command for easier doc generation
  2. Update CONTRIBUTING.md to clearly explain when/why you need to regenerate and commit

This should help prevent CI failures by making the documentation requirements more explicit.

- Add composer docs command for easier doc generation
- Update CONTRIBUTING.md with clear when/why instructions
- Explain that docs must be regenerated after code changes and merging from master

This helps prevent CI failures due to outdated documentation.
Copy link
Copy Markdown

@mokuzon mokuzon left a comment

Choose a reason for hiding this comment

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

@Ayoub-Mabrouk We sincerely apologize for the delay in approving your contribution.
Thank you for your contribution!

@mokuzon mokuzon added this pull request to the merge queue Apr 7, 2026
Merged via the queue into line:master with commit 2bd0e49 Apr 7, 2026
8 checks passed
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.

Improve documentation generation instructions in CONTRIBUTING.md

4 participants