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

Add short descriptions of each service to the reference home page #1285

Open
shepazon opened this issue Jan 4, 2024 · 0 comments
Open

Add short descriptions of each service to the reference home page #1285

shepazon opened this issue Jan 4, 2024 · 0 comments
Labels
documentation This is a problem with documentation.

Comments

@shepazon
Copy link
Contributor

shepazon commented Jan 4, 2024

Describe the issue

The reference home page starts off with a brief introduction, then is just a bare list of each service class in the SDK. It would be extremely helpful to have a short description of each class, perhaps using a definition list format, or presenting the service classes in a table with the first column being the service class link, and the second column a short description. Either format would work and would make identifying the right class much easier.

Links

https://sdk.amazonaws.com/swift/api/awssdkforswift/latest/documentation/awssdkforswift

@shepazon shepazon added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Jan 4, 2024
@jbelkins jbelkins removed the needs-triage This issue or PR still needs to be triaged. label Jan 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation.
Projects
None yet
Development

No branches or pull requests

2 participants