doc: comment every code snippet to maintain a godoc ref about dcr

[i-am-yuvi]

Okay I think I can do this, I have contributed to numerous docs of open source and have written many technical articles.
Assign me this asap

[qascade]

Hey, @i-am-yuvi thanks for your enthusiasm. Currently no issues are being assigned until GSSoC Mentors are onboarded. That should happen by EOD. Then I will start assigning the issues. You can start looking at the code and the spec docs and try to understand the project in the meanwhile.

[Vethan123]

hii ! i have contributed huge number of docs, So i think i can do this. Assign this to me please!!

[ShivangShandilya]

Would like to work on this if possible

[harshsingh32]

I would like to work on this issue, please assign this issue to me under GSSoC'23. I have relevant experience in the tech and could resolve this issue.

[qascade]

Assigning this to @Vethan123. Please start going through the spec docs and code. Ping me here once you are done with that.

[qascade]

Others can look at some other beginner-friendly issues that I have posted.

[Vethan123]

@qascade after completion of reading the spec doc and code what should i do?
please explain me in brief such that document can be effective.

[qascade]

@Vethan123 This PR will amend following things.

• Will make Readme.md visually better.
• Explain Example scenarios in the project effectively
• Add comments on top of each function in the file according to godoc ref guidelines.
• Add a godoc ref link button on readme.md
• Replace cli pictures with better visuals.
• Anything related to general contribution stuff, not in the scope of this PR. Already added in GSSoC Guidelines.
• Let's go in a top down approach manner
  a. package collaboration
  b. then package config and address and so on.

Just write whatever you understand of the function as per your understanding. I will keep asking changes in the reviews as per my understanding. Please add a query on discussion section if you have any general query related to the project.

[qascade]

Name the new branch doc.godoc_ref, which should point to the main. Make sure that every commit message is meaningful and atomic. A single package can have one commit attributed to it. Do not commit unfinished comments. Make sure to follow commit conventions used in the repo properly.

[qascade]

@ShivangShandilya Are you planning to work on this issue?

[flr22bbn]

Hello @qascade
I am a GSSoC23 contributor. I would love to contribute and make the doc better. Please assign this to me.
Thank you