Schlagwort: Arduino Docs

  • What’s up, Docs? Arduino Docs gets a revamp!

    What’s up, Docs? Arduino Docs gets a revamp!

    Reading Time: 3 minutes

    Have you checked out Arduino Docs lately? If it looks different, that’s because we can finally reveal the makeover we’ve been working on for months – in line with our constant efforts to learn, improve, and share all of it along the way!

    You can always count on Arduino Docs

    Arduino Docs is our public and collaborative repository of info, tech specs, and tutorials. It is a huge mass of online resources that we create, organize and maintain also thanks to our amazing community’s contributions (managed via GitHub: here’s how you can help if you are interested). 

    With 75+ current hardware products documented, hundreds of tutorials, and dozens of datasheets, it’s definitely the go-to resource center any time you have a new Arduino product, want to learn a new skill, or need help to figure something out! Want to host a web server on your brand new MKR WiFi 1010? Can’t wait to dive into the ultimate manual for your Opta micro PLC? Wondering how to set up a security system using ML? Need a solid starter guide for Arduino Cloud, the IDE 2, or Arduino in general? Arduino Docs has you covered, with specific and updated information to support all of this and so much more.

    What’s new and improved!

    Open-source through and through, Arduino Docs is a shared space that’s wonderfully alive with updates and new ideas. But it can also get messy and confusing – and that’s why we decided to revamp its design and architecture completely, to improve your experience and navigation.

    Our goal was to make all the resources more accessible: easier to find, easier to consult. That’s why you can now explore a new and improved Arduino Docs:

    • It welcomes you with a new homepage. Don’t know where to start? Pick one of the main sections featured here: choose between hardware, software or Cloud, and see what each one has to offer.
    • It has a sidebar so you never get lost. The side menu mirrors the main sections and drills down so you always know where you are as you browse documentation.
    • It streamlines finding hardware info. Datasheets and tutorials specific to each component are now presented within its dedicated page.
    • It helps you get started. As much as we’ve worked on making specific items more intuitive to find, we know sometimes you’re just curious about discovering more about a broader subject. That’s why we’ve included new suggestions to get started with the Arduino Cloud or MicroPython, and you’ll see a whole Learn section prominently displayed.
    • It looks (and works) better on mobile. A big improvement for smaller devices! 

    The myriad resources and open-source nature of the project remain the same. But they now live in a neater home, where it’s easier and faster for you to find everything you need to discover, learn, make, and share your knowledge about Arduino. 

    The post What’s up, Docs? Arduino Docs gets a revamp! appeared first on Arduino Blog.

    Website: LINK

  • Arduino Documentation Goes Open-Source for Community Contributions

    Arduino Documentation Goes Open-Source for Community Contributions

    Reading Time: 3 minutes

    Arduino Team — February 28th, 2022

    Arduino Docs contributions through GitHub

    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!

    You can follow any responses to this entry through the RSS 2.0 feed.
    You can leave a response, or trackback from your own site.

    Website: LINK

  • Arduino Docs has all the info you ever need about Arduino boards

    Arduino Docs has all the info you ever need about Arduino boards

    Reading Time: 4 minutes

    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.

    Arduino Docs is now live

    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.
    Pinout Diagrams on Arduino Docs

    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.

    Resources for all boards on Arduino Docs

    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.

    You can follow any responses to this entry through the RSS 2.0 feed.
    You can leave a response, or trackback from your own site.

    Website: LINK