search

awsdocs / aws-cdk-guide

User guide for the AWS Cloud Development Kit (CDK).
Other
335 stars 222 forks source link

Create Dash DocSet #219

Closed iloveitaly closed 4 years ago

iloveitaly commented 4 years ago

It would be amazing to have the CDK docs in Dash (local documentation manager):

https://kapeli.com/docsets

ghost commented 4 years ago

@iloveitaly Are you looking for API reference, Dev Guide, both?

We do offer the Dev Guide in Kindle and PDF for your offline needs. I'm not sure that adding another offline format will become a priority for our build engineers, but you never know!

iloveitaly commented 4 years ago

@Jerry-AWS For the API reference. Right now, I can't find any offline zip file with the HTML for the cdk HTML API reference. Additionally, there's no search or filtering in the online API docs, which makes them hard to use.

Dash solves this problem and makes it really easy to search and navigate documentation without having to jump into the browser and jump around. Here's an example with the nodejs docs:

image

It would be amazing if we could have this for CDK—full text search and method/symbol fuzzy matching would be incredibly helpful for developing in CDK.

ghost commented 4 years ago

That does look really nice.

The CDK developers build the API Reference; I'll open an issue over in their repo. https://github.com/aws/aws-cdk

ghost commented 4 years ago

I added this issue over there: https://github.com/aws/aws-cdk/issues/8617

So I'll close this one.