Skip to content

Reference content bundled with Arduino IDE is very outdated #8860

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
per1234 opened this issue May 9, 2019 · 2 comments · Fixed by #11495
Closed

Reference content bundled with Arduino IDE is very outdated #8860

per1234 opened this issue May 9, 2019 · 2 comments · Fixed by #11495
Assignees
Labels
Component: Documentation Related to Arduino's documentation content Component: IDE The Arduino IDE Type: Bug

Comments

@per1234
Copy link
Collaborator

per1234 commented May 9, 2019

The Arduino IDE comes with a copy of the Arduino Language Reference and some library reference pages. These are used to provide documentation accessed via Help > Reference and the context menu's "Find in Reference".

The Arduino Language Reference content is at least 1.5 years out of date.

The library reference pages appear to be ~2 years out of date at least, since this change made Jul 17, 2017 is not present: #6507
I didn't check back farther than that.

Since that time, many updates, corrections, and improvements have been made to the reference content. These files should be updated on every release of the Arduino IDE.

Originally reported at:
https://forum.arduino.cc/index.php?topic=613108.msg4166197#msg4166197

@per1234 per1234 added Component: Documentation Related to Arduino's documentation content Type: Bug labels May 9, 2019
@facchinm
Copy link
Member

@per1234 the script we used to launch was https://github.com/arduino/Arduino/blob/master/build/create_reference.pl . I think it is very outdated now and should be ported to the new reference architecture.
@cmaglie @mastrolinux @gvarisco any idea?

@alranel
Copy link

alranel commented Feb 8, 2021

I think we should just remove the offline version for now, and launch the online one when the reference menu item is selected.

@cmaglie cmaglie added this to the Release 1.8.14 milestone May 6, 2021
cmaglie added a commit to cmaglie/Arduino that referenced this issue May 7, 2021
The offline documentation is hard to update and gets outdated very
quickly.

Fix arduino#8860
cmaglie added a commit to cmaglie/Arduino that referenced this issue May 7, 2021
The offline documentation is hard to update and gets outdated very
quickly.

Fix arduino#8860
cmaglie added a commit to cmaglie/Arduino that referenced this issue Aug 18, 2021
The offline documentation is hard to update and gets outdated very
quickly.

Fix arduino#8860
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation Related to Arduino's documentation content Component: IDE The Arduino IDE Type: Bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants