search

nRF24 / RF24Network

OSI Layer 3 Networking for nRF24L01(+) and nRF52x on Arduino and Raspberry Pi
https://nrf24.github.io/RF24Network/
GNU General Public License v2.0
356 stars 164 forks source link

deploy documentation using Github Pages #161

Closed 2bndy5 closed 3 years ago

2bndy5 commented 3 years ago

This issue is part of an effort to start hosting nRF24 org repos' docs on github per individual repo instead of uploading all RF24* lib's docs to tmrh20.github.io.

I've created a github workflow that builds the docs on every commit. This same workflow will upload the generated HTML files to the "gh-pages" branch upon publishing a new release. Notice I've already taken the liberty to create the "gh-pages" branch for this repo.

  1. For this workflow to work properly, this repo's settings needs to have the "gh-pages" branch set to the Github Pages Source option: image After enabling this option, I expect the first deployment to Github Pages to render an error message.

  2. Additionally, it would less visually noisy if the "packages" & "environments" sections are hidden in the repo's sidebar settings: image

When these stipulations have been met in the repo settings I will submit a PR

2bndy5 commented 3 years ago

I'm editing all doc links (not RF24 install script link for all RF24 libraries) to the nRF24 org repos. I found a broken link that leads to tmrh20.github.io/RF24Network_Dev. Should it be without the "_Dev" part?

this dead link appears a few times, but here is 1 line for reference

TMRh20 commented 3 years ago

Yeah, all the network_dev links should be changed to just network.