Documentation Explosion
RDoc.info is a web service that generates and hosts documentation for your favorite GitHub-hosted Ruby libraries and Rails plugins. Just add a post-commit hook to your project and it’ll take…
RDoc.info is a web service that generates and hosts documentation for your favorite GitHub-hosted Ruby libraries and Rails plugins. Just add a post-commit hook to your project and it’ll take care of updating your API docs every time you push to the remote.
What, not cool enough for your hipster threads? Well it also masquerades as the docs user on GitHub, and auto-publishes your docs directly to GitHub Pages using a familiar theme. There’s more on how this works here. For an example, check the HTTParty docs or visit http://docs.github.com to get started.
Both of these projects are hosted here (and here) on GitHub, so fork away if you have ideas for improvements. Huge kudos to zapnap and jeffrafter for this awesome use of GitHub Pages and for starting this great service for the community.
Written by
Related posts
GitHub Availability Report: September 2024
In September, we experienced three incidents that resulted in degraded performance across GitHub services.
Code referencing now generally available in GitHub Copilot and with Microsoft Azure AI
Announcing the general availability of code referencing in GitHub Copilot and Microsoft Azure AI, allowing developers to permit code suggestions containing public code matches while receiving detailed information about the match.
The nuances and challenges of moderating a code collaboration platform
Sharing the latest data update to our Transparency Center alongside a new research article on what makes moderating a code collaboration platform unique.