-
- Notifications
You must be signed in to change notification settings - Fork 490
Style Guide Tutorials #231
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
39 commits Select commit Hold shift + click to select a range
b6345fa
adding and moving around style guides
jhansson-ard a2f1b82
formatted library creating guide
jhansson-ard 6b79f70
updated tags
jhansson-ard 17bc1d6
renamed folder and updated frontmatter
jhansson-ard a3331b4
renamed folder
jhansson-ard 746a4fb
moved style content
jhansson-ard ac77c2e
moved folders..again
jhansson-ard f70dd51
adding title to category
jhansson-ard eca5c31
adding image guide iamges
jhansson-ard 513f892
added images and how to take screenshots
jhansson-ard 507c076
updating hyperlinks to pages
jhansson-ard bce3541
reordering content and adding contributing page
jhansson-ard d5d0747
removed image style guide as it is not yet done
jhansson-ard 2cf1257
Update content/learn/08.contributions/04.arduino-creating-content-gui…
jhansson-ard 1436500
Update content/learn/08.contributions/04.arduino-creating-content-gui…
jhansson-ard 0c9d59d
Update content/learn/08.contributions/00.arduino-writing-style-guide/…
jhansson-ard c4518b8
Update content/learn/08.contributions/04.arduino-creating-content-gui…
jhansson-ard 606f9a0
Update content/learn/08.contributions/01.arduino-library-style-guide/…
jhansson-ard 6d5de4f
Update content/learn/08.contributions/01.arduino-library-style-guide/…
jhansson-ard 189a883
Update content/learn/08.contributions/01.arduino-library-style-guide/…
jhansson-ard 9240e81
Update content/learn/08.contributions/01.arduino-library-style-guide/…
jhansson-ard 429856e
Update content/learn/08.contributions/03.arduino-creating-library-gui…
jhansson-ard 2b136e0
Update content/learn/08.contributions/03.arduino-creating-library-gui…
jhansson-ard f5eed32
Update content/learn/08.contributions/04.arduino-creating-content-gui…
jhansson-ard f77a1f2
Update content/learn/08.contributions/03.arduino-creating-library-gui…
jhansson-ard 305b57f
Update content/learn/08.contributions/00.arduino-writing-style-guide/…
jhansson-ard 259888c
Update content/learn/08.contributions/04.arduino-creating-content-gui…
jhansson-ard e6aeace
Update content/learn/08.contributions/00.arduino-writing-style-guide/…
jhansson-ard d43e724
Update content/learn/08.contributions/04.arduino-creating-content-gui…
jhansson-ard 240c396
Update content/learn/08.contributions/01.arduino-library-style-guide/…
jhansson-ard 0974342
Update content/learn/08.contributions/01.arduino-library-style-guide/…
jhansson-ard f285408
Update content/learn/08.contributions/01.arduino-library-style-guide/…
jhansson-ard a297aa5
Update content/learn/08.contributions/01.arduino-library-style-guide/…
jhansson-ard a9a1255
Update content/learn/08.contributions/01.arduino-library-style-guide/…
jhansson-ard a4c39ff
Update content/learn/08.contributions/01.arduino-library-style-guide/…
jhansson-ard 2a43c12
Update content/learn/08.contributions/03.arduino-creating-library-gui…
jhansson-ard 6fa509f
Update content/learn/08.contributions/03.arduino-creating-library-gui…
jhansson-ard 90311c7
Update content/learn/08.contributions/03.arduino-creating-library-gui…
jhansson-ard 80dfeaf
Update content/learn/08.contributions/01.arduino-library-style-guide/…
jhansson-ard File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
reordering content and adding contributing page
- Loading branch information
commit bce35417fa39b5991996d33d3c7a50445f7fe130
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
34 changes: 34 additions & 0 deletions 34 ...ntributions/04.arduino-creating-content-guide/arduino-creating-content-guide.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
title: 'Writing Content for Arduino' | ||
description: 'How to write content for the Arduino Documentation Website' | ||
tags: | ||
- Styleguide | ||
- Guidelines | ||
--- | ||
| ||
## Adding your own content | ||
| ||
You are welcome to add your own content to the Arduino Documentation repository. You can contribute with the following content: | ||
| ||
|Content|Description|Example| | ||
|-------|-----------|-------| | ||
|Tutorial|Learn how to do something.|[Control Built-in RGB LED over Wi-Fi with Nano RP2040 Connect](https://docs.arduino.cc/tutorials/nano-rp2040-connect/rp2040-web-server-rgb)| | ||
|Article|Learn about a specific topic.|[Multimeter Basics](https://docs.arduino.cc/learn/electronics/multimeter-basics)| | ||
|Nugget|Smaller tutorial with less information and more straight to the example.|[Analog Read Serial](https://docs.arduino.cc/built-in-examples/basics/AnalogReadSerial)| | ||
|Project|Learn how to build something.|[DIY Photoshop Editing Console using Arduino Nano RP2040 Connect](https://create.arduino.cc/projecthub/jithinsanal1610/diy-photoshop-editing-console-using-arduino-nano-rp-2040-a43e97?ref=search&ref_id=nano%20rp2040%20connect&offset=0)| | ||
jhansson-ard marked this conversation as resolved. Outdated Show resolved Hide resolved | ||
| ||
\*Note that the contributed Projects should be added to **Project Hub** instead of on the Arduino Documentation website. | ||
| ||
***You can also contribute to our content by creating your own libraries. Read more about that [here](../03.arduino-creating-library-guide).*** | ||
| ||
For us to be able to approve your contribution, you should follow the guidelines on how to structure and write your content. | ||
| ||
## Styleguides | ||
| ||
If you want to write your own content, please read the following guides on how to write in a user friendly way. | ||
| ||
* [Arduino Style Guide for Writing Content](../00.arduino-writing-style-guide) | ||
| ||
If you want to contribute with your own content to the Arduino Documentation website, please read the following documentation on how to do just that. | ||
| ||
* [Contribution Content](https://github.com/arduino/docs-content/contribution-templates) | ||
jhansson-ard marked this conversation as resolved. Outdated Show resolved Hide resolved jhansson-ard marked this conversation as resolved. Outdated Show resolved Hide resolved |
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.