Skip to content

Latest commit

 

History

History
executable file
·
57 lines (34 loc) · 2.46 KB

README.md

File metadata and controls

executable file
·
57 lines (34 loc) · 2.46 KB
Raw

PyroCMS Documentation v2.2.0

This repo is home to the PyroCMS documentation source.

Doc Versions

The documentation tags mirror the x.y release tags of PyroCMS, so the v2.2.0 documentation is on branch 2.2, and so on. Once a new version of PyroCMS is in development, a new branch of documentation will be available on this repo. Please make sure when you are contributing a documentation change you are using the appropriate branch.

Contributing to the Docs

To contribute to the PyroCMS docs, fork this repo to your local environment. The PyroCMS docs run off of a simple flat-file based CMS written in CodeIgniter. It doesn't need a database to run, so you should be able to load up the docs easily.

The actual doc files are contained in the content folder, and the folder structure mirrors the URL structure. Each page is a markdown file which either has a matching URI name, such as constants-and-globals.md, or in a folder like page-subsection/index.md. For instance, the Core Plugins file is at plugins/index.md.

Helping Grow the Docs

If you'd like to help out with the docs, here are some areas we are working on:

  • Spotting and documenting any undocumented features, parameters, etc.
  • Spotting and fixing broken internal doc links
  • Checking docs for spelling, grammar, and clarity

If you have doc feedback, please feel free to use the GitHub inline code commenter.

Docs Style Guide

Format

All doc files must be .md files and written in Markdown (except for HTML tables which can be written in plain HTML).

Internal doc links should be formatting using the link plugin. Here's an example:

{{ link uri="general/basics/organization" title="Organization" }}

The yellow "tip" boxes (as seen on such pages as the Lex Parser developer guide) should follow this HTML structure:

<div class="note"><p>Content Here</p></div>

These boxes should be used when there is important information the user should take note of that may get lost in a general paragraph.

Organization

The docs are organized into multiple categorized sections:

  • Getting Started
  • Guides
  • Core Modules
  • Core Plugins
  • Core Widgets
  • Core Field Types
  • Developer Docs
  • PyroCMS Pro
  • Reference

If you are creating a new page, it should fit reasonably within one of the existing sections. If you think we need a new section, or want to suggest some organizational changes, please email adam@pyrocms.com.