You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Some open source repositories have a cool feature that when you make a pull request it automatically generates the documentation page as a check in the pull request so people can verify the updates to the documentation work as required. Is this possible to do?
Makes it much easier to check without needing to install & build the docs manually on the user's & maintainer's laptop.
Regenerating the docs that frequently can be costly in Github CI bills. For now, we'll have it such that folks that are making edits should check it locally on their machine, or for small things that do not require a rebuild of the docs (typos, small simple edits), no regeneration is necessary. Any errors will also be corrected before the doc branch is merged into master.
Some open source repositories have a cool feature that when you make a pull request it automatically generates the documentation page as a check in the pull request so people can verify the updates to the documentation work as required. Is this possible to do?
Makes it much easier to check without needing to install & build the docs manually on the user's & maintainer's laptop.
Example of a good repository that does this - ONEARMY/academy#120
The text was updated successfully, but these errors were encountered: