Documentation in Open Source

[peculiaruc]

Description:

Overview of Documentation in open source. its important and how to write a good documentation.

Action to Take:

1. Write a Script - Check out the samples and please use this template
2. Create a Slide deck - Find a sample here, and please use this template
3. Record a video - Sample

Additional context

• Kindly go through the ReadMe.md file.
• Contributing.md file contains information that will help you get started
• Choose your preferred background for your video recording. if you need one.

[motuncoded]

I am interested in working in this

[motuncoded]

https://docs.google.com/document/d/1Y-664nRZHUsqq66xgNleUFsD2FaFZD925WB3rd99Urc/edit?usp=sharing

script

I am not done with the script. I would be using the content from the slide to complete when I created that

[motuncoded]

Please I am requesting for the slide template

[peculiaruc]

The slide template is added in the issue, kindly check and use it. Also give us time to review the script and approve it.

[peculiaruc]

https://docs.google.com/document/d/1Y-664nRZHUsqq66xgNleUFsD2FaFZD925WB3rd99Urc/edit?usp=sharing

script

I am not done with the script. I would be using the content from the slide to complete when I created that

Hi @motuncoded Please a PR once you are done with script or Slide deck

[Dipro-cyber]

@peculiaruc Hello Ma'am, are the PRs still open here? Can I contribute? I am a beginner so looking forward to contribute to the good first issues.

[peculiaruc]

@peculiaruc Hello Sir, are the PRs still open here? Can I contribute? I am a beginner, so looking forward to contribute to the good first issues.

Yes, Thanks for your interest in working on this issue. I am happy to assign it to you. Feel free to ask me any questions on how to move forward. We usually chat about it during our working group meetings too.