Skip to content
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

Link to API Reference Client from README #1878

Closed
trivikr opened this issue Jan 6, 2021 · 1 comment · Fixed by #1907
Closed

Link to API Reference Client from README #1878

trivikr opened this issue Jan 6, 2021 · 1 comment · Fixed by #1907
Labels
documentation This is a problem with documentation.

Comments

@trivikr
Copy link
Member

trivikr commented Jan 6, 2021

Describe the issue with documentation
The client READMEs refer to root README, which provides generic information about v3.
Since API Reference is now available, the client READMEs should refer to API Reference.

Example client-s3 README: https://github.com/aws/aws-sdk-js-v3/blob/master/clients/client-s3/README.md
It currently links to root README https://github.com/aws/aws-sdk-js-v3
It should link to https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/classes/s3.html instead. In future, the client README can be populated with examples.

To Reproduce (observed behavior)
Visit landing page for client-s3 API Reference https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/index.html

Expected behavior
The README should link to API reference for Client object.

Additional context
Refs: #1877 (comment)

@github-actions
Copy link

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 29, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation This is a problem with documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant