rpi tcpip doc

[epsi1on]

as discussed in #41

[TMRh20]

Nice work! I'll try to take a closer look over the weekend here and see if I have any suggestions, but so far I see all the main stuff is covered.

[epsi1on]

@2bndy5 , thanks for the precise suggestions. All suggestions are applied.
Regards

resolved

[2bndy5]

@epsi1on I added the ability to preview doc changes in a PR using readthedocs. If you could rebase your branch on upstream's master branch, the docs preview will begin to show in this PR.

git pull
git rebase upstream/master
git push --force

Then we can access the docs preview from the "checks":

[TMRh20]

@epsi1on My only real suggestion here is to modify the main docs page and add a link, probably under the installation section, to this new page. Title should be something like "Setup a RPi to RPi TCP/IP Link over nRF24L01"

[epsi1on]

@epsi1on I added the ability to preview doc changes in a PR using readthedocs. If you could rebase your branch on upstream's master branch, the docs preview will begin to show in this PR.

git pull
git rebase upstream/master
git push --force

Then we can access the docs preview from the "checks":

did it.

[epsi1on]

@epsi1on My only real suggestion here is to modify the main docs page and add a link, probably under the installation section, to this new page. Title should be something like "Setup a RPi to RPi TCP/IP Link over nRF24L01"

I did edit main page and added a link at buttom. thanks to @2bndy5 it have a preview now:

https://rf24gateway--42.org.readthedocs.build/en/42/

[epsi1on]

still not sure how to put the link for image

[2bndy5]

still not sure how to put the link for image

Doxygen supports 2 syntax.

1. Using markdown syntax
2. Using doxygen's @image command

Note

The image must be placed in the images folder, not the docs/images folder.

I prefer to use method 1. If customizing the size of the image is desired then use method 2.

[epsi1on]

still not sure how to put the link for image

Doxygen supports 2 syntax.

1. Using [markdown syntax](https://www.doxygen.nl/manual/markdown.html#md_images)

2. Using [doxygen's `@image` command](https://www.doxygen.nl/manual/commands.html#cmdimage)

Note

The image must be placed in the images folder, not the docs/images folder.

I prefer to use method 1. If customizing the size of the image is desired then use method 2.

It would be resolved now. Could you please do a check?!

[2bndy5]

Odd, my suggestion didn't fix the image link. It looks like doxygen's config needs to be updated:

RF24Gateway/docs/Doxyfile

Line 206 in 8b2afa7

IMAGE_PATH = ../examples/ncurses

[2bndy5]

I pushed a commit that fixed showing the image. LGTM now. Thanks again!

[TMRh20]

Looks good, thanks!

[2bndy5]

changes are live! 🎉

I also cherry picked this patch to v1.x branch 😉

[epsi1on]

Thanks all