Pages: [1]   Go Down
Author Topic: Typos in Arduino reference documentation  (Read 4829 times)
0 Members and 1 Guest are viewing this topic.
Keeping it weird in Portland
Offline Offline
Newbie
*
Karma: 1
Posts: 44
Arduino Noob, Veteran Programmer
View Profile
 Bigger Bigger  Smaller Smaller  Reset Reset

I'd like to help improve the quality of the Arduino documentation by pointing out typos in the English Arduino documentation. I would be happy to edit the files that are locally installed during the Arduino IDE installation and sharing the files with someone from time to time unless there is some other preferred method of reporting errors and typos.
Logged

Global Moderator
Boston area, metrowest
Offline Offline
Brattain Member
*****
Karma: 538
Posts: 27113
Author of "Arduino for Teens". Available for Design & Build services. Now with Unlimited Eagle board sizes!
View Profile
WWW
 Bigger Bigger  Smaller Smaller  Reset Reset

Yeah, us too.
Contact The Arduino Team listed on the home page, see if they're willing to accept the help.
Logged

Designing & building electrical circuits for over 25 years. Check out the ATMega1284P based Bobuino and other '328P & '1284P creations & offerings at  www.crossroadsfencing.com/BobuinoRev17.
Arduino for Teens available at Amazon.com.

Miramar Beach, Florida
Offline Offline
Faraday Member
**
Karma: 147
Posts: 6038
View Profile
 Bigger Bigger  Smaller Smaller  Reset Reset

I just emailed the webmaster for arduino.cc for instructions on submitting website changes. If I get a response, I'll post it here.

I've been waiting for a couple changes for at least a month. I posted them here on the forum. I have another I would like to submit now, but I don't want to feel like I am wasting my time.

Maybe we are supposed to email them?
O forse le modifiche devono essere presentate in Italiano?
« Last Edit: August 26, 2013, 02:25:19 pm by SurferTim » Logged

Norfolk UK
Offline Offline
Faraday Member
**
Karma: 69
Posts: 2557
View Profile
 Bigger Bigger  Smaller Smaller  Reset Reset

It also amazes me that the off-line reference documentation does not match the on-line version. Specific example is the extra protocol selection for Serial.begin that has been documented on-line since at least IDE 1.0.3 but even with IDE 1.0.5 it is still not in the off-line reference.
Logged


Miramar Beach, Florida
Offline Offline
Faraday Member
**
Karma: 147
Posts: 6038
View Profile
 Bigger Bigger  Smaller Smaller  Reset Reset

I guess I am wasting my time. Two days and no email response from the webmaster.  smiley-sad
Logged

Norfolk UK
Offline Offline
Faraday Member
**
Karma: 69
Posts: 2557
View Profile
 Bigger Bigger  Smaller Smaller  Reset Reset

I guess I am wasting my time. Two days and no email response from the webmaster.  smiley-sad
It's a real shame that people are willing to assist but nobody in charge seems to care. Not sure if it's just plain indifference (documentation does not pay there salaries), a fear of loosing control or something else.
Logged


New York
Offline Offline
Newbie
*
Karma: 0
Posts: 23
Arduino rocks
View Profile
 Bigger Bigger  Smaller Smaller  Reset Reset

The forum and the webmaster are not the appropriate places to report issues with documentation, which are treated like bugs. Please check if it's already known by looking at http://github.com/arduino/Arduino/issues, and if it's not known, add it to the list.

You can also email documentation@arduino.cc

As for this specific request regarding the offline docs, it's already being looked into.
Logged

Miramar Beach, Florida
Offline Offline
Faraday Member
**
Karma: 147
Posts: 6038
View Profile
 Bigger Bigger  Smaller Smaller  Reset Reset

The forum and the webmaster are not the appropriate places to report issues with documentation, which are treated like bugs.
That is not correct. The forum in this topic and an email to webmaster@arduino.cc is the correct procedure. Every change I have submitted in that way has been corrected. The delay above was caused by a webmaster on vacation.  smiley-wink
Logged

Pages: [1]   Go Up
Jump to: