The osCommerce Library serves both core and community contributed documentation to help users with products and services built for and around osCommerce Online Merchant. The authoring standards ensures a consistent structure and layout for both core and community contributed documentation for easier reading.
The structure of the Library is defined as Sections -> Books -> Chapters -> Pages. For example:
| Sections | Books | Chapters | Pages |
|---|---|---|---|
| Core | osCommerce Online Merchant v2.3 | Getting Started |
Requirements Pre-Installation Steps New Installation Post-Installation Steps |
| Community Packages | PayPal | osCommerce Online Merchant v2.3 |
PayPal Express Checkout PayPal Payments Standard |
The documentation content is written in HTML files and stored in self-contained directories with a json file defining the content ordering. Writing new or updating existing documentation is as easy as pushing the changes to your git repository and sending pull requests to the main repository hosted at GitHub. The changes from GitHub are then pulled from the server to publish on the Library.
The Community Packages section is unique in the Library where the content is actually hosted on external git repositories and is only linked via git submodules. This allows developers to create their own repositories to document their Add-Ons with and to have the Library dynamically build a list of documentation books available for Add-Ons.