Add documentation

Looking at a project’s dependencies and realizing that it uses the amazon-cognito-identity-js package as opposed to the more common aws-sdk. Since I’m unfamiliar with it, I want to understand what my options are for refactoring the code it’s used in.

I end up on the npm page, where the 32 arbitrary copy-pasta samples in the README seem old enough to drink, but I want to know what namespaces there are and what arguments the various constructors and methods actually accept, so I search for “doc” (as in “docs” or “documentation”) but that only leads me to a 404 on the Webpack website. While it’s a wonderful tool, it has very little to do with how my team writes code that interacts with AWS.

Describe the solution you’d like Perhaps auto-generating some sort of actual documentation from the Typescript definition file which is apparently present in the repository?

Edit: Or merely mentioning that the typings file exists, beyond a minimal mention in the changelog. ¯\_(ツ)_/¯

Describe alternatives you’ve considered Auth0

Additional context Developers often want to understand function arguments and return values and having documentation for your package helps them do that. Links from the official AWS docs to Javascript SDK documentation only leads to documentation for the aws-sdk package.

[Sleavely]

@gergob According to the readme, the reason the amazon-archives/amazon-cognito-identity-js repo is archived is because it was merged into the amplify-js repository.

[mauerbac]

@Sleavely, I think we’ve addressed the concerns here so going to close this out.