What is a documentation?

[Unalia09]

I was reading some of the discussions and in one such discussion it said that for a new coder it is recommended to contribute in documentation. I'm very new to all this :'D

[Hemu21]

Hello @Unalia09 , contributing to the document means. If you check the readme.md file of the particular project. They should need some specific updates. You can check the issue exists or not regarding document update if exists then ask for assign else you can rise the issue that you want to update the readme.md file or some any other document file. This is recommended for who are not much familiar with coding but anyone can do this. you check the here they mentioned about this https://www.youtube.com/live/K55HMy7alag?si=zNVqFkCBMBmQtdz7 you can try the practice contribution.

[Unalia09]

Thankyou for the answer!!

[Princegupta101]

Documentation is project details and all process , tech stack details and much more
@Unalia09

[aayushyadavz]

if you are asking with respect to GSSOC'24 documentation is a readme.md file in which the repository admin has provided all the information regarding that repo or project in which you are interested in contributing. Hope you got your answer.

[Unalia09]

Yep!!

[aayushyadavz]

mark my reply as answered.

[MrCodYrohit]

Hiii @Unalia09 Yes, it's often recommended for newcomers to begin their journey in open source by contributing to documentation. This is because documentation contributions are typically less complex compared to code contributions and provide a great opportunity for beginners to familiarize themselves with the project structure, development workflow, and version control systems like Git. Plus, improving documentation helps not only the project maintainers but also other contributors and users who rely on clear and comprehensive documentation to understand and use the project effectively. So, it's a win-win situation for everyone involved!

[alpharsh]

Documentation is like the user manual for software or code it tells you how stuff works and how to use it. Contributing to documentation means writing or improving these instructions. It's a good way for new coders to learn and help others understand code better.

Hope this answer helps!

[dpvasani]

@Unalia09
GSSoC'24, documentation often refers to the README.md file or other similar markdown files in the repository that provide crucial information about the project. These files help potential contributors understand:

• What the project does
• How to set up the development environment
• Guidelines for contributing (like coding standards, issue templates, etc.)
• How the codebase is organized
• Troubleshooting instructions or FAQs

For beginners, contributing to documentation is an excellent entry point because it:

1. Introduces them to Git and GitHub without the complexity of coding.
2. Helps them get familiar with the project structure and coding practices.
3. Improves their communication skills by explaining technical concepts clearly.
4. Provides a low-barrier way to start contributing to open source.

It's a win-win because maintainers often need better or updated documentation, and new contributors gain experience with open-source collaboration!

[madhavi-peddireddy]

Documentation is a crucial part of any project as it provides clear instructions on how to use, contribute to, or maintain the project. For GSSoC'24, contributing to documentation, like improving the README.md file, is an excellent way for beginners to get started with open source. It helps newcomers understand the project structure, improves communication skills, and makes the project more accessible to others. You can start by checking for existing issues related to documentation or suggest improvements based on your experience.

[DibyadyutiDas]

It's perfect for beginners because you don’t need advanced coding skills, and it’s a great way to learn about a project while making a real impact.

How to Contribute to Documentation

1. Find a Project
   Look for projects you like on platforms like GitHub Explore or First Timers Only.
   Check for labels like good first issue or documentation.

2. Spot Documentation Issues
   Look in the README.md or Issues tab for:
   Typos or outdated info.
   Missing setup instructions.
   Anything unclear.

3. Fork & Clone the Repo
   Click Fork on the repo’s page to copy it to your account.
   Clone it to your computer:

4. Edit the Documentation
   Open the file (usually README.md or in /docs) in a text editor.
   Fix errors, improve clarity, or add details.
   Preview changes in Markdown editors like VS Code.

5. Commit & Push Changes
   Save your work:
   bash
   Copy
   Edit
   git add .
   git commit -m "Improved documentation clarity in README.md"
   git push origin main

6. Submit a Pull Request
   Go to the original repo and click Compare & Pull Request.
   Write a short title and explain your changes.
   Submit your PR and respond to any feedback from maintainers.

Celebrate Your Contribution!
Once your PR is merged, you've officially contributed to open source!