aws / aws-sdk-js-v3

Modularized AWS SDK for JavaScript.
Apache License 2.0
2.95k stars 554 forks source link

Create validation script for api-extractor.json to consistently publish API docs for public components #6174

Open kuhe opened 3 weeks ago

kuhe commented 3 weeks ago

Describe the issue

On our API docs site, some symbols don't link to anything. This makes discovery very difficult unless you read the API through your actual code editor.

The validation should do the following:

Links

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-smithy-client/Class/Command/

kuhe commented 3 weeks ago

Context: we reduced the number of packages published to the API docs website to reduce the chances of users getting lost.

Not all package exported symbols are considered public API. But those that are should be published to the site.