Catalyst
We're still working on this part.
Documentation
Catalyst has documentation folders in two places:
- The Catalyst core /catalyst/documentation/
- The Catalyst Apps dirs /catalyst/app/[appName]/documentation/
Each documentation folder has two files:
- user.html for end user documentation, how to use the app from a user perspective.
- dev.html for developers, how to use the app at as a coder.
When writing or editing a doc, the following rules apply:
- Only HTML. PHP and JS don't work.
- No body, head or additional HTML document tags. Simply the HTML for the article.
- Only one H1 tag at the top with the name of the app.
- Use H2 tags for each section to map to the Table of Contents.
What happens on rendering/viewing the document:
- All H2 tags get a #(hashbang) link and anchor, added to the Table of Contents.
- The Table of Contents list is drawen directly after the H1 tag in the document.