Improve Documentation [Important] (Read Comments) #1181
Replies: 21 comments 1 reply
-
|
@HarshCasper Can i take this one, considering I am doing the styling anyways in #762 I will deal with the content of the Files |
Beta Was this translation helpful? Give feedback.
-
Sure. Please do it in batch and let me know which batch you are working on. |
Beta Was this translation helpful? Give feedback.
-
|
Just as Note: Anyone can work on this! Just comment the batches that you like to work on and make a PR 😉 |
Beta Was this translation helpful? Give feedback.
-
|
Is this issue open for DWoC too? |
Beta Was this translation helpful? Give feedback.
-
Yeah. Go ahead |
Beta Was this translation helpful? Give feedback.
-
|
Hey there! |
Beta Was this translation helpful? Give feedback.
-
Thanks for the interest! Can you take up a batch of Scripts lacking proper documentation and make a PR for? Not much, but 5-7 of them in single batches would be good. |
Beta Was this translation helpful? Give feedback.
-
|
Sure, I'll try my best @HarshCasper |
Beta Was this translation helpful? Give feedback.
-
|
Can I work on this @HarshCasper . As I am a beginner in coding I want to Update the Documentation. |
Beta Was this translation helpful? Give feedback.
-
Yes you can |
Beta Was this translation helpful? Give feedback.
-
|
@vybhav72954 I'd like to work on few documentations, Can i? |
Beta Was this translation helpful? Give feedback.
-
Yes PLease. Open a PR as soon as you have sorted out a few. |
Beta Was this translation helpful? Give feedback.
-
|
@vybhav72954 I would like to work on some of the documentations as a GSSoC participant, may I? |
Beta Was this translation helpful? Give feedback.
-
|
Sure thing. You can open a PR as soon as you can sort a few README, around 4-5 (min). Please follow the proper markdown guidelines
|
Beta Was this translation helpful? Give feedback.
-
|
@HarshCasper |
Beta Was this translation helpful? Give feedback.
-
|
@mansijain980 The issue is open to everyone, all you need to do is, upgrade a bunch of READMEs and open a PR (Say 5-6 in one PR). |
Beta Was this translation helpful? Give feedback.
-
|
Ok thanks. |
Beta Was this translation helpful? Give feedback.
-
|
@HarshCasper @vybhav72954 Would love to try my hands to improve the readme. But I have one doubt like how would I figure out from the above-mentioned list which of the readme's are updated till now or is it the above list is updated one for whom no pull request is made yet. Like suppose if someone else is working on the same readme's that I am working then I might possibly have merge conflicts |
Beta Was this translation helpful? Give feedback.
-
Hi sumit... Thanks for the interest... This is issue as we speak is going some changes (might be even closed). Kindly take up something else. Meanwhile we will discuss about the issue and will keep you posted as soon as we arrive at the proper goals and outcomes of this issue. |
Beta Was this translation helpful? Give feedback.
-
|
Yah thank u..would love to know more whenever things get sorted regarding the issue.. |
Beta Was this translation helpful? Give feedback.
-
|
@HarshCasper I think it's best to close this, or maybe convert it into a discussion? |
Beta Was this translation helpful? Give feedback.
-
|
Done @vybhav72954 @sumitgsh You can take up 3-4 audits in a single go and send PRs for them for easy review. |
Beta Was this translation helpful? Give feedback.
-
Description
Update incomplete README. As many of the Contributors might have noticed, we have a long list of Scripts along with appropriate documentation on how to launch and work with them.
Unfortunately, a lot of Scripts have been pushed without a lot of strongest checks and reviews. We can work on improving the documentation for scripts that lack a proper information.
Thanks to @avinal we now have a long list of Documentation that is not properly done or followed up. Here is a list of them:
First-Time Contributors (or even those who have landed some contributions) can take up them in batches (maybe 5-7) and raise a PR for them. As a reference take a look at our README template before you start modifying the Script. It would also be a good opportunity in finding some dead code, understanding how these scripts work and stepping up with future contributions.
Beta Was this translation helpful? Give feedback.
All reactions