-
Notifications
You must be signed in to change notification settings - Fork 162
docs: improve go docs by adding a readme #3204
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
I deployed a preview to https://6883d84fdd2114b798da2f70--adbc-docs.netlify.app if anyone wants to take a look. I think this is pretty promising as a way of achieving #3198 without abandoning the built-in Go pkgsite documentation tool. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just some nit picks!
|
Thanks for the reviews. After creating this PR, I found out you can do some degree of package-level documentation in source code headers and also in standalone doc.go files but you're limited to only a single heading level which I don't think is ideal. I'm going to keep going with the README.md approach since it seems to work and address the feedback. |
|
I addressed a number of the comments around my incorrect/imprecise language by avoiding it altogether since it wasn't critical. I tested the code by extracting it into a test package (awk command included in README) so I feel pretty good about it now. @zeroshade can you give this a +1 if you like the direction? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a couple nitpicks, but otherwise +1 from me!
|
Merged, thanks for the reviews. |
Improves the existing go pkgsite by adding a README.
This is an alternative to #3199.