Utopia::Project
A simple Ruby project documentation website.
Motivation
I've used many documentation tools. Most are over-complicated and focus on what is possible rather than what is useful. Because I manage many open source projects, at a certain scale it makes sense to build something to suit your needs rather than try to adapt to existing systems. This is one such instance.
My goal is to provide task-centric documentation, and to continually improve the way it's presented. The primary entry point for new developers are the structured usage guides, however having rich cross-referencing into the code is equally important.
With that in mind, this web application provides such a model and will evolve over time to suit my requirements and the needs of my users.
Usage
Please browse the source code index or refer to the guides below.
Getting Started
This guide explains how to use utopia-project for your own project.
Documentation Formatting
This guide explains the conventions used by utopia-project when generating documentation for your project.
GitHub Pages Integration
This guide shows you how to use utopia-project with GitHub Pages.
Contributing
We welcome contributions to this project.
- Fork it.
- Create your feature branch (
git checkout -b my-new-feature). - Commit your changes (
git commit -am 'Add some feature'). - Push to the branch (
git push origin my-new-feature). - Create new Pull Request.