Skip to content

Conversation

@amoeba
Copy link
Member

@amoeba amoeba commented Jul 25, 2025

Improves the existing go pkgsite by adding a README.

This is an alternative to #3199.

@amoeba amoeba requested a review from zeroshade as a code owner July 25, 2025 19:19
@github-actions github-actions bot added this to the ADBC Libraries 20 milestone Jul 25, 2025
@amoeba
Copy link
Member Author

amoeba commented Jul 25, 2025

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.

Copy link
Member

@zeroshade zeroshade left a 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!

@amoeba
Copy link
Member Author

amoeba commented Jul 28, 2025

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.

@amoeba
Copy link
Member Author

amoeba commented Jul 29, 2025

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?

Copy link
Member

@zeroshade zeroshade left a 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!

@amoeba amoeba merged commit 0489d94 into apache:main Aug 5, 2025
36 checks passed
@amoeba
Copy link
Member Author

amoeba commented Aug 5, 2025

Merged, thanks for the reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants