Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE REQUEST] Add documentation preview on pull request #307

Closed
darigovresearch opened this issue May 8, 2021 · 3 comments
Closed
Labels
area: docs Improvements or additions to documentation type: enhancement New feature or request

Comments

@darigovresearch
Copy link

darigovresearch commented May 8, 2021

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

@G-Pereira G-Pereira added area: docs Improvements or additions to documentation type: enhancement New feature or request labels May 14, 2021
@darigovresearch
Copy link
Author

For additional context they use netlify but there are other options mentioned however not sure if there is one for docsy

ONEARMY/project-kamp-academy#10 (comment)

@sphawes
Copy link
Member

sphawes commented May 11, 2022

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.

@sphawes sphawes closed this as completed May 11, 2022
@darigovresearch
Copy link
Author

Sounds good!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Improvements or additions to documentation type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants