A simple Ruby project documentation website.
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.
Please see the project documentation for more details.
-
Getting Started - This guide explains how to use
utopia-projectfor your own project. -
Documentation Formatting - This guide explains the conventions used by
utopia-projectwhen generating documentation for your project. -
GitHub Pages Integration - This guide shows you how to use
utopia-projectwith GitHub Pages.
Please see the project releases for all releases.
- Support brief release notes in
releases.mddocument.
- Utopia — The website framework which powers this web application.
- Decode — The source code parser and cross-referencing library.
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.
In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.
This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.