Skip to main content

One post tagged with "jamstack analytics"

View All Tags

· 3 min read

The success of any software depends partly on its documentation. A good documentation can make or break a great software because people need to know how to use it and in case of a developer facing software, it needs examples and properly documented API. SQL Frames uses TypeScript and a nice API documentation can be generated using the TYPE DOC system. However, to show case all the features and provide a low-code software documentation experience, it needed a good documentation framework. In addition, as SQL Frames runs within the browser, a key requirement is to be able to author documentation with inline live examples.