Skip to content

Link Redirect Problem in the Stream Related Files, occurring in the Documentation #654

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
animeshsrivastava24 opened this issue Jul 3, 2019 · 2 comments
Labels

Comments

@animeshsrivastava24
Copy link
Contributor

animeshsrivastava24 commented Jul 3, 2019

The files present in the Folder: reference-en/Language/Functions/Communication/Stream/
Contain Links in each documentation which doesn’t lead us to correct page.
For example:

  1. Consider the file streamAvailable
    On line 18: It has a link Stream class which redirects a user to https://github.com/arduino/reference-en/blob/master/Language/Functions/stream, but the correct link should be https://github.com/arduino/reference-en/tree/master/Language/Functions/Communication/Stream
  2. Consider the file streamFind
    On line 17: It has a link Stream.setTimeout() which redirects a user to https://github.com/arduino/reference-en/blob/master/Language/Functions/Communication/streamsettimeout, but it should be https://github.com/arduino/reference-en/blob/master/Language/Functions/Communication/Stream/streamSetTimeout.adoc

I found these instances in various files of Stream. I checked this on the website and it is working fine there but not in the documentation present in the repo. I am a little confused due to this.
@per1234 Please guide me whether this is a problem or not.

@per1234
Copy link
Collaborator

per1234 commented Jul 4, 2019

This is because on arduino.cc each page is a folder, while on GitHub each page is only a file. You will notice this in the relative links where there is one more layer of .. than you would expect. So there is no problem. The files in the reference repositories are intended to be used to generate the Language Reference on arduino.cc. The fact that GitHub renders asciidoc is convenient, but it should not be considered an indication that the language reference content is intended to ever be read by users here on GitHub.

@per1234 per1234 closed this as completed Jul 4, 2019
@per1234 per1234 added the invalid label Jul 4, 2019
@animeshsrivastava24
Copy link
Contributor Author

Thank you so much for explaining me about it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants