Links to generated documentation content don't work when docs are viewed in the GitHub repository
ChiefBacon opened this issue · 2 comments
Describe the problem
The integrations options page links to a nonexistent gRPC documentation page. I don't know if I have just been looking in the wrong place, but I can not find any other detailed information about the gRPC connection. Thanks :)
To reproduce
N/A
Expected behavior
N/A
Arduino CLI version
N/A
Operating system
N/A
Operating system version
N/A
Additional context
No response
Issue checklist
- I searched for previous reports in the issue tracker
- I verified the problem still occurs when using the nightly build
- My report contains all necessary details
Hi @ChiefBacon. The gRPC documentation is generated from the source code, so we don't store it in the standard repository files. For this reason, the link doesn't work if you view the documentation files via the GitHub repository. You should instead view the documentation via the documentation website, here:
https://arduino.github.io/arduino-cli/latest/
It would be interesting to investigate whether the links to the gRPC documentation (and the links to the command line documentation) could be changed to work even when viewing the documentation files via the GitHub repository, without impacting the functionality of the website (and the website generation infrastructure).
Ah, yes, I see! Thanks for pointing that out, and this doc helps a lot. I should be able to figure it out from here, thanks!