Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
32 lines (19 sloc) 1.46 KB
title id
About the docs
about

Mission statement

Good documentation is at the heart of all successful open source projects. With this platform, we aim to:

  • Provide a platform that is easy to contribute to and maintain
  • Provide documentation that is a joy to read and navigate
  • Provide a system that can build the same documentation source to multiple output formats
  • Provide stewardship such that the documentation is well kept and ever-growing

Contributing

You'll find information on ways in which you can contribute in the [[docs-content]] and [[docs-build]] sections. The quickest and easiest way to get started is fixing mistakes and omissions by finding the pencil icon in pages and editing directly in GitHub then submitting a Pull Request (the GitHub UI takes care of most of this for you).

Technology

Lucee

The documentation build is achieved using Lucee code. The only dependency required to build and locally run the documentation is CommandBox.

Markdown

We chose to use Markdown with a few common and custom enhancements.

We also based the system on a popular open source static CMS system called Grav. This gives us a proven foundation to build the source from and should help make contributing as easy as it can be.

For more information on how the documentation is formatted, see the [[docs-content]] section.