As you know, Arduino is all about open source, and now our Docs and Help Center sites now join the community club becoming open-source. Arduino lovers everywhere can now contribute to the content on official Arduino documentation websites through their public GitHub repositories.
How you can contribute
You’ll need a GitHub account, since it’s all handled through the repository.
Head on over to the Docs repo or the Help Center repo. In the file list, you’ll see the “content” folder, which is the various pages are found. You might need to tunnel down through it until you eventually find the page you’re looking for, but it’s in there.
The content can be edited directly in GitHub, so there’s no need to download anything. Just make the changes, suggestions or contributions that you want. You can then create a branch and click the “Pull request” button, and your changes will be sent to the Arduino Docs team to be reviewed. If they’re accepted, you’ll be credited in the Git history for your contributions!
For the tutorial pages on the various boards hosted in Docs, you can find a shortcut to the correct file in GitHub. On the right hand side of the page you’ll see a new box, called “Suggest Changes”. The “Edit this page” button takes you straight to the relevant file in the GitHub repo, so you don’t need to drill down through the content folder to find it.
What you can contribute
It doesn’t necessarily have to be simple corrections or edits, either. If you want to submit your own tutorial or article, you can do so by forking the repository, adding your content there and eventually create a pull request.
Everything on the site is very carefully curated, so we can’t guarantee that contributions will be published, but you’re more than welcome if you feel you’ve something valuable to share. Make sure you read the guidelines and consider summarizing your proposal in the issue tracker before starting to write the actual content, to get feedback from our content team and the community.
So keep your eagle eye out on the repository for any opportunity to become a contributor and join the community!
The truth is, we never entirely got to grips with Arduino documentation. Until now. Now there’s a new standard for gathering together product info, tech specs and tutorials, that we’re calling Arduino Docs. We’re excited to share it with the Arduino community who’ll soon be able to help it grow.
It Began with the Uno
When the Arduino Uno was launched around 15 years ago, its detailed documentation was a vital part of its success. It wouldn’t be at all unreasonable to say that its online resources were a driving factor in the establishment and growth of the primordial Arduino community.
But you’re probably quite aware of Arduino’s history, and the rapid growth that followed. Creating, organizing and maintaining that level of documentation around each and every board became a huge task. The complexity was one thing, but the open-source nature also meant that a lot of third party content was generated. Which is great, and is still very much encouraged, but it also muddied the waters of supporting content.
So getting all that essential info together in one place, while providing a great experience for the users, has been a passion project for a lot of people at Arduino. And now, it’s ready.
Which brings us back to today, and the launch of a whole new approach to the online presence of Arduino boards. Welcome to Arduino Docs.
The All New Arduino Docs Site
The new Arduino Docs site launches with a detailed, but easy-to-use breakdown of everything you ever wanted to know about the official boards and products.
Every product will get its own page, broken down into standardized sections so you have instant, easy access to what you need.
Overview: You’ll begin here when you take a look at a board on the Arduino Docs site. It’s a bird’s-eye-view of the board’s description and purpose, its main features, tech specs, revision logs (where applicable) and compatibility options.
Essentials: This section gets you started with using the board in question. Here you’ll find quick start guides, suggestions for libraries, and useful basics on using Arduino. Perfect for newcomers or anyone needing a refresher.
Tutorials: Any and all tutorials connected to the board will be marshalled here. You’ll never have to go hunting when you’re looking to build something awesome. These tutorials will showcase the different features of each board, giving you a full understanding of what’s possible.
Resources: This is where we’ll keep the datasheets, downloads, pinout diagrams, schematics and other useful documents and files.
It’s been no small feat collating all this information, and reformatting into something that’s as useful for beginners as it is for experts and engineers. It’ll kick off with over 130 tutorials, dozens of boards, and a great selection of shields, all given a brand new home.
But it’s not just about the hardware. The new Arduino Docs site aims to be the most encyclopedic resource we’ve ever compiled, so it includes sections for software (such as the IDEs), Cloud (for the web editor and other Arduino Cloud tools) and a great asset for understanding the foundations of Arduino’s approach to electronics.
Cool Community Content
Lots of companies say they’re all about community. But in our case it’s actually true! Arduino isn’t a company or a board or a platform. It’s a community.
You guys created much of the content, tutorials and documentation out there. That’s not going to change now that we’ve launched Arduino Docs. GitHub is home to the whole system (we’re tech nerds, we can’t help it). That means members of the community will soon be able to add, edit and influence the Arduino Docs content.
The content team will review and approve submissions and branches made through GitHub. So what you’re seeing right now is the embryonic stage of Arduino Docs. We envisage amazing things once the community is able to get involved. Sign up to our newsletter so we can keep you posted on when that becomes possible, and about updates, leaks and more.
We’re very proud of the work that the various internal teams have done in making this happen. We hope you are too, and as always we really want any and all feedback you have on this new and valuable Arduino resource.
Please go and take a look, and do stop by the forums to tell us all about your experience.
In our latest resource, we show you how to create a website and use it to document your coding projects.
Why document your code?
Search the web with the right key words for your programming conundrum, and you’re bound to find someone who has written software to address a question that’s at least similar to yours. And not only that, they’re also making their software freely available under an open source license, and writing documentation to help you use their code. How awesome is that?!
Many people who write code are eager to share their programs and allow others to use and remix them according to their own needs. This is why the open source community is so inviting for makers, especially those who want to make projects that are yet beyond their ability to build from scratch.
So unless you plan on turning your code into a money-making commodity, you’re writing scripts that you can share with others. By adding clear, supporting online documentation to your code, you’ll help people all over the world to not only use your software but to also understand what everything does and become better programmers themselves.
Our resource
In our latest resource, we show you how to use docstrings to automatically create documentation for your Python code. Then, we walk you through using Sphinx to build a website showcasing this documentation and any example scripts you want to share with the world.
You’ll learn how to create supporting documentation to guide users through elements of your code, add multiple pages to your website, and use themes to costumise the site’s layout and make it stand out.
We’ve refreshed the developer documentation and API reference experience to help you find the guides and materials needed to rapidly deliver apps to your users and the Twitch community. This release is an early step toward delivering a developer experience that inspires and delights you to create with our products.
Rather than myself talking about it, check it out at dev.twitch.tv/docs.
We strive to create a docs experience that responds to customer feedback and incorporates idioms common to best-in-class documentation apps. Here are some highlights from this release:
Search: Yes! You can search across all of our documentation, and we’ll match by title, content, or API references.
Sticky navigation: As you browse content, you’ll know exactly where you are in the document with a helpful indicator. Having the navigation accessible at all times should make it easier to hop back and forth, and get what you need.
Three-column reference browsing: We’ve pulled out sample request and and response returns for every API method (including V5), making it easy to try our capabilities as you build iteratively for your users. Here’s an example which documents the method to GET users.
Mobile-friendly: Open docs on an iPad, phone, or other device in case you need a quick reference in a smaller viewport.
In future releases, we hope to make it easier to get to “Hello, World!” and success with our products. Be on the lookout for more in the coming months.
Dr. Ellis Silver claims that supremely intelligent extraterrestrials put humans on Earth as recently as tens of thousands of years ago. Here are just some of the reasons: „[humans are] surprisingly unsuited and ill-equipped for Earth’s environment [because they’re] harmed by sunlight, [have] a strong dislike for naturally occurring foods, ridiculously high rates of chronic disease, and more.“
In his recent, he also says that „Neanderthals such as homo erectus were crossbred with another species, perhaps from Alpha Centauri, which is the closest star system to our solar system, some 4.37 light years away from the sun.“
That’s not all that Dr. Ellis Silver has to say, he adds: „…mankind may have evolved on a different planet, and we may have been brought here as a highly developed species.
One reason for this…is that the Earth might be a prison planet, since we seem to be a naturally violent species and we’re here until we learn to behave ourselves.“
Um dir ein optimales Erlebnis zu bieten, verwenden wir Technologien wie Cookies, um Geräteinformationen zu speichern und/oder darauf zuzugreifen. Wenn du diesen Technologien zustimmst, können wir Daten wie das Surfverhalten oder eindeutige IDs auf dieser Website verarbeiten. Wenn du deine Einwillligung nicht erteilst oder zurückziehst, können bestimmte Merkmale und Funktionen beeinträchtigt werden.
Funktional
Immer aktiv
Die technische Speicherung oder der Zugang ist unbedingt erforderlich für den rechtmäßigen Zweck, die Nutzung eines bestimmten Dienstes zu ermöglichen, der vom Teilnehmer oder Nutzer ausdrücklich gewünscht wird, oder für den alleinigen Zweck, die Übertragung einer Nachricht über ein elektronisches Kommunikationsnetz durchzuführen.
Vorlieben
Die technische Speicherung oder der Zugriff ist für den rechtmäßigen Zweck der Speicherung von Präferenzen erforderlich, die nicht vom Abonnenten oder Benutzer angefordert wurden.
Statistiken
Die technische Speicherung oder der Zugriff, der ausschließlich zu statistischen Zwecken erfolgt.Die technische Speicherung oder der Zugriff, der ausschließlich zu anonymen statistischen Zwecken verwendet wird. Ohne eine Vorladung, die freiwillige Zustimmung deines Internetdienstanbieters oder zusätzliche Aufzeichnungen von Dritten können die zu diesem Zweck gespeicherten oder abgerufenen Informationen allein in der Regel nicht dazu verwendet werden, dich zu identifizieren.
Marketing
Die technische Speicherung oder der Zugriff ist erforderlich, um Nutzerprofile zu erstellen, um Werbung zu versenden oder um den Nutzer auf einer Website oder über mehrere Websites hinweg zu ähnlichen Marketingzwecken zu verfolgen.
