Skip to content

Links to generated documentation content don't work when docs are viewed in the GitHub repository #2859

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

Closed
3 tasks done
ChiefBacon opened this issue Mar 9, 2025 · 2 comments
Assignees
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project

Comments

@ChiefBacon
Copy link

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
@ChiefBacon ChiefBacon added the type: imperfection Perceived defect in any part of project label Mar 9, 2025
@per1234 per1234 added the topic: documentation Related to documentation for the project label Mar 9, 2025
@per1234
Copy link
Contributor

per1234 commented Mar 9, 2025

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).

@per1234 per1234 changed the title gRPC Documentation is missing Links to generated documentation content don't work when docs are viewed in the GitHub repository Mar 9, 2025
@ChiefBacon
Copy link
Author

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!

@per1234 per1234 self-assigned this Mar 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Development

No branches or pull requests

2 participants