Switch to Developer

Catalyst

We're still working on this part.

Documentation

Catalyst has documentation folders in two places:

  1. The Catalyst core /catalyst/documentation/
  2. The Catalyst Apps dirs /catalyst/app/[appName]/documentation/

Each documentation folder has two files:

  1. user.html for end user documentation, how to use the app from a user perspective.
  2. dev.html for developers, how to use the app at as a coder.

When writing or editing a doc, the following rules apply:

  1. Only HTML. PHP and JS don't work.
  2. No body, head or additional HTML document tags. Simply the HTML for the article.
  3. Only one H1 tag at the top with the name of the app.
  4. Use H2 tags for each section to map to the Table of Contents.

What happens on rendering/viewing the document:

  1. All H2 tags get a #(hashbang) link and anchor, added to the Table of Contents.
  2. The Table of Contents list is drawen directly after the H1 tag in the document.