Why is the v2 documentation so bad?

[k-dahl]

On https://aws.github.io/aws-sdk-go-v2/docs/ the information is extremely sparse.

Neither of the site searches work - the sidebar one does nothing when a search term is entered and enter is pressed:

The nav bar search does nothing when a search term is entered and enter is pressed:

The API Reference link leads to this page:

https://pkg.go.dev/github.com/aws/aws-sdk-go-v2#section-readme

...which ALSO has no searchable documentation:

[stefansundin]

I was about to open a new issue or discussion about the search being broken but I found this.

It looks like the JavaScript is attempting to load https://aws.github.io/aws-sdk-go-v2/offline-search-index.9f33279f24e0567986b8fc9db212092b.json but that leads to a 404 error.

Not sure how to best get the attention of the AWS SDK team about this issue... This may not work but I am going to try to mention a random AWS person who is creating PRs in this repository:

@lucix-aws you are our only hope 😄

This is probably an easy fix now that we know why the search isn't working.

[lucix-aws]

The frustration here is totally warranted. Note that we do have a strategic initiative ongoing at this time to consolidate all of our AWS SDK docs - so, the GitHub pages-hosted documentation we have for the v2 SDK is getting reformatted and moved to the standard AWS SDK documentation portal. That work is ongoing and should categorically solve the navigation/search issues on the page.

Unfortunately we don't have any control over the pkg.go.dev docs - the source for that is owned by Google and mirrored at https://github.com/golang/pkgsite, you can follow the instructions there if you'd like to file an issue.

To the original comment about the current developer guide being informationally sparse - we'd like to hear specific feedback about what is missing, if you could share. We do also have a dedicated template for documentation if you'd like to file an issue.

[stefansundin]

You do have control over https://aws.github.io/aws-sdk-go-v2/docs/ so please at least fix the search on that website. Please open that page and open your browser developer tools and you will see that https://aws.github.io/aws-sdk-go-v2/offline-search-index.9f33279f24e0567986b8fc9db212092b.json fails to load which is why the search is broken. That is probably a simple fix.

[stefansundin]

@lucix-aws Is it possible that you can address the search functionality being broken at least? That's the biggest current problem in my opinion, and it should in theory be very easy to fix.

Please open https://aws.github.io/aws-sdk-go-v2/docs/ and open your browser developer tools and you will see that https://aws.github.io/aws-sdk-go-v2/offline-search-index.9f33279f24e0567986b8fc9db212092b.json fails to load which is why the search is broken.