Skip to content

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 39 commits into from
May 20, 2022
Merged

Style Guide Tutorials #231

merged 39 commits into from
May 20, 2022

Conversation

ArduinoBot
Copy link
Collaborator

This PR updates some style guides on how to create content, including

  • creating your own library
    • styling the library and documentation around it
  • writing contribution content (old content moved)

What Needs To Be Reviewed

  • that the placement of the content make sense
  • that the content inside the tutorials fits what we want to say and share

How To Give Feedback

Please leave your feedback as a Github review.
You can add comments to specific lines of content / code and ideally use Github's suggestion feature. 🙏

jhansson-ard and others added 17 commits May 5, 2022 09:10
@jhansson-ard @marqdevx
adding and moving around style guides
b6345fa
@jhansson-ard @marqdevx
formatted library creating guide
a2f1b82
@jhansson-ard @marqdevx
updated tags
6b79f70
@jhansson-ard @marqdevx
renamed folder and updated frontmatter
17bc1d6
@jhansson-ard @marqdevx
renamed folder
a3331b4
@jhansson-ard @marqdevx
moved style content
746a4fb
@jhansson-ard @marqdevx
moved folders..again
ac77c2e
@jhansson-ard @marqdevx
adding title to category
f70dd51
@jhansson-ard @marqdevx
adding image guide iamges
eca5c31
@jhansson-ard @marqdevx
added images and how to take screenshots
513f892
@jhansson-ard @marqdevx
updating hyperlinks to pages
507c076
@jhansson-ard @marqdevx
reordering content and adding contributing page
bce3541
@jhansson-ard @marqdevx
removed image style guide as it is not yet done
d5d0747
@jhansson-ard @karlsoderby @marqdevx
Update content/learn/08.contributions/04.arduino-creating-content-gui…
2cf1257 
…de/arduino-creating-content-guide.md

Co-authored-by: Karl Söderby <[email protected]>
@jhansson-ard @karlsoderby @marqdevx
Update content/learn/08.contributions/04.arduino-creating-content-gui…
1436500 
…de/arduino-creating-content-guide.md

Co-authored-by: Karl Söderby <[email protected]>
@jhansson-ard @marqdevx
Update content/learn/08.contributions/00.arduino-writing-style-guide/…
0c9d59d 
…arduino-writing-style-guide.md
@jhansson-ard @karlsoderby @marqdevx
Update content/learn/08.contributions/04.arduino-creating-content-gui…
c4518b8 
…de/arduino-creating-content-guide.md

Co-authored-by: Karl Söderby <[email protected]>
@jhansson-ard jhansson-ard requested a review from karlsoderby May 12, 2022 11:50
@gatsby-cloud
Copy link

gatsby-cloud bot commented May 12, 2022 •
edited
Loading

Gatsby Cloud Build Report

docs-content

🎉 Your build was successful! See the Deploy preview here.

Build Details

View the build logs here.

🕐 Build time: 4m

@jhansson-ard
Copy link
Contributor

@karlsoderby please check the comments of commit suggestions :)

per1234
per1234 requested changes May 12, 2022
View reviewed changes
jhansson-ard and others added 4 commits May 12, 2022 15:17
jhansson-ard and others added 5 commits May 12, 2022 15:18
@jhansson-ard @per1234
Update content/learn/08.contributions/03.arduino-creating-library-gui…
429856e 
…de/arduino-creating-library-guide.md

Co-authored-by: per1234 <[email protected]>
@jhansson-ard @per1234
Update content/learn/08.contributions/03.arduino-creating-library-gui…
2b136e0 
…de/arduino-creating-library-guide.md

Co-authored-by: per1234 <[email protected]>
@jhansson-ard @per1234
Update content/learn/08.contributions/04.arduino-creating-content-gui…
f5eed32 
…de/arduino-creating-content-guide.md

Co-authored-by: per1234 <[email protected]>
@jhansson-ard @per1234
Update content/learn/08.contributions/03.arduino-creating-library-gui…
f77a1f2 
…de/arduino-creating-library-guide.md

Co-authored-by: per1234 <[email protected]>
@jhansson-ard
Update content/learn/08.contributions/00.arduino-writing-style-guide/…
305b57f 
…arduino-writing-style-guide.md
jhansson-ard and others added 4 commits May 12, 2022 16:07
@jhansson-ard @per1234
Update content/learn/08.contributions/04.arduino-creating-content-gui…
259888c 
…de/arduino-creating-content-guide.md

Co-authored-by: per1234 <[email protected]>
@jhansson-ard @per1234
Update content/learn/08.contributions/00.arduino-writing-style-guide/…
e6aeace 
…arduino-writing-style-guide.md

Co-authored-by: per1234 <[email protected]>
@jhansson-ard @per1234
Update content/learn/08.contributions/04.arduino-creating-content-gui…
d43e724 
…de/arduino-creating-content-guide.md

Co-authored-by: per1234 <[email protected]>
@jhansson-ard @per1234
Update content/learn/08.contributions/01.arduino-library-style-guide/…
240c396 
…arduino-library-style-guide.md

Co-authored-by: per1234 <[email protected]>
@per1234
Copy link
Contributor

per1234 commented May 18, 2022

Hi @jhansson-ard. There are still some outstanding suggestions from my previous review. Please make a ruling on those.

jhansson-ard and others added 8 commits May 18, 2022 11:21
@jhansson-ard @per1234
Update content/learn/08.contributions/01.arduino-library-style-guide/…
0974342 
…arduino-library-style-guide.md

Co-authored-by: per1234 <[email protected]>
@jhansson-ard @per1234
Update content/learn/08.contributions/01.arduino-library-style-guide/…
f285408 
…arduino-library-style-guide.md

Co-authored-by: per1234 <[email protected]>
@jhansson-ard @per1234
Update content/learn/08.contributions/01.arduino-library-style-guide/…
a297aa5 
…arduino-library-style-guide.md

Co-authored-by: per1234 <[email protected]>
@jhansson-ard @per1234
Update content/learn/08.contributions/01.arduino-library-style-guide/…
a9a1255 
…arduino-library-style-guide.md

Co-authored-by: per1234 <[email protected]>
@jhansson-ard @per1234
Update content/learn/08.contributions/01.arduino-library-style-guide/…
a4c39ff 
…arduino-library-style-guide.md

Co-authored-by: per1234 <[email protected]>
@jhansson-ard @per1234
Update content/learn/08.contributions/03.arduino-creating-library-gui…
2a43c12 
…de/arduino-creating-library-guide.md

Co-authored-by: per1234 <[email protected]>
@jhansson-ard @per1234
Update content/learn/08.contributions/03.arduino-creating-library-gui…
6fa509f 
…de/arduino-creating-library-guide.md

Co-authored-by: per1234 <[email protected]>
@jhansson-ard @per1234
Update content/learn/08.contributions/03.arduino-creating-library-gui…
90311c7 
…de/arduino-creating-library-guide.md

Co-authored-by: per1234 <[email protected]>
@jhansson-ard
Copy link
Contributor

@karlsoderby @per1234 please check again if you feel happy about the documents ⭐

@jhansson-ard @per1234
Update content/learn/08.contributions/01.arduino-library-style-guide/…
80dfeaf 
…arduino-library-style-guide.md

Co-authored-by: per1234 <[email protected]>
per1234
per1234 approved these changes May 20, 2022
View reviewed changes
Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I'm very happy to see the restoration of this important document to the Arduino website.

@jhansson-ard jhansson-ard merged commit f057c17 into main May 20, 2022
@jhansson-ard jhansson-ard deleted the sync/jhansson-ard/styleguide-tutorials branch May 20, 2022 12:14
Serjlee pushed a commit that referenced this pull request Dec 21, 2022
@jacobhylen
Merge pull request #231 from arduino/jacobhylen/nano-ble-sense-rev2-c…
c7187fc 
…ontent

Nano 33 BLE Sense rev2 documentation update
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jhansson-ard jhansson-ard jhansson-ard left review comments

@per1234 per1234 per1234 approved these changes

@karlsoderby karlsoderby Awaiting requested review from karlsoderby

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ArduinoBot @jhansson-ard @per1234 @karlsoderby