Skip to content
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

Missing links to specific types in the API reference #2113

Closed
Dapid opened this issue Jul 18, 2024 · 1 comment
Closed

Missing links to specific types in the API reference #2113

Dapid opened this issue Jul 18, 2024 · 1 comment

Comments

@Dapid
Copy link

Dapid commented Jul 18, 2024

There are sections of the documentation, such as JsonString that are not accessible from anywhere in the reference guide. They should be, because otherwise it is hard to find the methods (in fact, I only encountered that one because searching with the type took me there).

@bblanchon
Copy link
Owner

Hi @Dapid,

Thank you very much for reporting this issue.
There were already links on all pages that mentioned JsonString.

  1. https://arduinojson.org/news/2022/01/08/arduinojson-6-19-0/
  2. https://arduinojson.org/v6/api/jsonobject/begin_end/
  3. https://arduinojson.org/v6/api/jsonobjectconst/begin_end/
  4. https://arduinojson.org/v6/doc/upgrade/
  5. https://arduinojson.org/v7/api/jsonobject/begin_end/
  6. https://arduinojson.org/v7/api/jsonobjectconst/begin_end/
  7. https://arduinojson.org/v7/how-to/upgrade-from-v5/

Also, if you hover the class name, the Arduino IDE shows the link to the documentation:

image

Lastly, you can easily find the page using arduinojson.org's built-in search:

image

Still, I added links on the following pages:

  1. https://arduinojson.org/v6/api/
  2. https://arduinojson.org/v7/api/

Let me know if you find other pages where I should add links.

Best regards,
Benoit

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants