Provide Godoc for all codebase #5737
Labels
area/contributing
Contributing docs, ownership, etc. Also devtools like devcontainer and Nix
area/docs
Incorrect, missing, or mistakes in docs
type/feature
Feature request
Summary
What change needs making?
Right now, In the argo-workflows codebase, there is no proper documentation of the file and it becomes difficult for beginners to identify what that particular file does so it will be good if this godoc enhancement we do it.
Use Cases
When would you use this?
This helps contributors to get more out of the codebase and eventually helps in the development of argo-workflows.
For beginners like me, I am having a hard time understanding codebase as there are a lot of files involved and the contributor workshop video helped a lot but it is 11 months old session, Many things have changed in 11 months so this need arisen.
https://blog.golang.org/godoc#:~:text=Godoc%20is%20conceptually%20related%20to,syntax%20(as%20with%20Javadoc).
Please have a look and if it is a good proposal then provide inputs and also 👍, Thank you.
Message from the maintainers:
Impacted by this bug? Give it a 👍. We prioritise the issues with the most 👍.
The text was updated successfully, but these errors were encountered: