search

phytec / doc-bsp-yocto

Yocto BSP Documentation
https://phytec.github.io/doc-bsp-yocto/
1 stars 1 forks source link

GH actions: add status check with documentation preview #203

Closed jonas-rem closed 2 months ago

jonas-rem commented 2 months ago

GitHub pages can host documentation previews for each pull request. This can be helpful for reviewing and getting an overview of changes quickly.

For testing check the passed checks: Check External Links / Click on details for a Doc Preview (pull_request)

jonas-rem commented 2 months ago

I think it is valuable you add a note or summary to the docs on how to use this.

I added a note to the Contributing guide.

I noticed that we may run into problems after some time if the documentation previews could make the GitHub Pages Repo too large (limit is 1GB). The 3rd commit adds a clean-up action that runs if the PR is closed or merged.