Skip to content
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

[Documentation] #24

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Conversation

AghaSaad04
Copy link

Signed-off-by: Agha Saad Fraz agha.saad04@gmail.com
I have to document this library while working as a technical writer for Arduino in GSoD. I have documented the Liquid Crystal library as per David Cuartielles' plan.

I have done the following steps

Followed writing standards
Added Description
Added Installation steps
Added Features
Added functions
Added example
Added contributing heading and its file
Added credits
Referenced external resources

Signed-off-by: Agha Saad Fraz <agha.saad04@gmail.com>
Signed-off-by: Agha Saad Fraz <agha.saad04@gmail.com>
Copy link

@sandeepmistry sandeepmistry left a comment

Choose a reason for hiding this comment

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

Hi @AghaSaad04,

First off, thanks for taking the time to submit this pull request!

I've made some comments, I think the best way to move forward is to decide as a team why this content needs to be in the read me vs being on the arduino.cc website with a link from the read me.

These comments probably also apply to: arduino-libraries/SigFox#19

@dcuartielles @cmaglie @facchinm @lxrobotics @agdl @SimonePDA @per1234 please review and let us know your thoughts.

README.adoc Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@per1234 per1234 added type: enhancement Proposed improvement topic: documentation Related to documentation for the project labels Apr 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants