laskoviymishka commented on PR #478: URL: https://github.com/apache/iceberg-go/pull/478#issuecomment-3041946904
> Couldn't we just improve the README and examples and just use https://pkg.go.dev/github.com/apache/iceberg-go? > With pkg.go.dev as the standard for Go documentation. I have some experience maintaining larger Go libraries, and while GoDoc is a good baseline, it doesn’t cover more general topics well. It tends to be fragmented and hard to follow, so you still need something on top of it to make the documentation truly readable and useful. There’s a problem with standard documentation - it doesn't cover broader or general topics. The same issue applies to both the Python and Rust documentation sites. From my perspective, a website is a great complement to the GoDoc. It can include more sophisticated examples, use cases, and general-purpose guides. > Keeping the website in sync with the code and docs seems like it would be more trouble. The good part is that we can still benefit from testable examples. Since the whole website is just markdown files in the repo, keeping them in sync should be doable. But I do agree - it's more work. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
