Documentation Files

This is the start of our documentation project—unfortunately we are way behind schedule. Right now there are just several files documenting some of the more important aspects of the code.

Our Three Write Rule
Our Five Minute Rule
Code Comments - About why we write code comments the way we do.
Code Execution - The basic code execution path.
Code Notes - About our code notation comments.
Config - About some more interesting aspects of the CONFIG code.
Database - The design of the databases.
Debugging - About debugging by print statements.
Error - About ERROR.PHP.
Error.ini - About ERROR.INI.
INI Files - About INI files.
HTML - About the HTML module.
Modules - About THIS modules.
MYSQL - About the MYSQL modules.
Post Format - About the post format.
Reshaping - A programming "way".
Rules - About the website's "RULES".
Sections - About THIS "sections".
Security - A little bit about security.
Templates - About the Web Templates.
Visitors - About what we call "Visitor Code".

These HTML files were all generated from text files with a command line PHP "tool" we are developing. The goal is to integrate (or to "intertwine") the documentation and the source code, with indexed and cross-referenced HTML files. You can also view the Source Code.