@_telegram and @dexyit: The best way to publish your API documentation October 12, 2012
Telegram is the best way to publish a web site. The content for Telegram sites can be hosted in GitHub, Git, and Dropbox. Thus, the management of the content and the versioning and access control and all the other stuff that most content management systems focus on is done by the best tools available today: Git for complex stuff and Dropbox for simple stuff. Telegram pushes the site by applying Hoisted to the contents of the repository resulting in a coherent, beautiful web site. Put another way, put Word, Markdown, HTML, Pages into Git/Dropbox and see the resulting site on Telegram or at your own domain.
Dexy is the most powerful, comprehensive documentation authoring system in the known universe. Dexy allows you to write documentation, compile example code, run example code, capture the output of the example code (as text, HTML, or a GIF snapshot of what the browser would display) and weave the output into your documentation.
As of today, Telegram automatically detects Dexy repositories and runs Dexy. Simple as pointing Telegram to a Git repo with a Dexy project in it and you get a brand-spanking shiny web site out the other side.
Telegram + Dexy = Continuous Documentation
Telegram and Dexy do for documentation what Heroku does for apps. Check in and the new stuff is live.
What does this mean:
- Your API documentation is always up to date
- If there's a bug in your sample apps or your API breaks sample apps, you'll know within minutes
- Your developers focus on the joy of writing code rather than the mechanics of keeping the API documentation site up to date
- Your API consumers have a better experience
Yes, Telegram and Dexy let you focus on your business, save money, and make your users happier. Yay!
Try it out
We're currently alpha testing Telegram, so if you want to try Telegram/Dexy integration, please join the wait list and we'll approve you pretty quickly (we want to see how the load on our servers is going). Then point Telegram to a Dexy repository in GitHub, watch the magic, and give us feedback.