# Utopia::Project

A simple Ruby project documentation website.

[![Development Status](https://github.com/socketry/utopia-project/workflows/Test/badge.svg)](https://github.com/socketry/utopia-project/actions?workflow=Test)

## 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 see the [project documentation](https://socketry.github.io/utopia-project/) for more details.

  - [Getting Started](https://socketry.github.io/utopia-project/guides/getting-started/index) - This guide explains how
    to use `utopia-project` for your own project.

  - [Documentation Formatting](https://socketry.github.io/utopia-project/guides/documentation-formatting/index) - This
    guide explains the conventions used by `utopia-project` when generating documentation for your project.

  - [GitHub Pages Integration](https://socketry.github.io/utopia-project/guides/github-pages-integration/index) - This
    guide shows you how to use `utopia-project` with GitHub Pages.

## Contributing

We welcome contributions to this project.

1.  Fork it.
2.  Create your feature branch (`git checkout -b my-new-feature`).
3.  Commit your changes (`git commit -am 'Add some feature'`).
4.  Push to the branch (`git push origin my-new-feature`).
5.  Create new Pull Request.

### Developer Certificate of Origin

This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.

### Contributor Covenant

This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

## See Also

  - [Utopia](https://github.com/socketry/utopia) — The website framework which powers this web application.
  - [Decode](https://github.com/ioquatix/decode) — The source code parser and cross-referencing library.