docs: improve documentation generation instructions#789
Open
Ayoub-Mabrouk wants to merge 1 commit intoline:masterfrom
Open
docs: improve documentation generation instructions#789Ayoub-Mabrouk wants to merge 1 commit intoline:masterfrom
Ayoub-Mabrouk wants to merge 1 commit intoline:masterfrom
Conversation
- 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.
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.
Closes #788
As mentioned in PR #772, contributors need clearer guidance on when and why to regenerate documentation. This PR addresses issue #788.
composer docscommand for easier doc generationThis should help prevent CI failures by making the documentation requirements more explicit.