Ardens Documentation System: Software Overview

Authors: Mark Rabideau, Gemini (Google) Date: October 2025

💻 Ardens Documentation System: Software Overview

This PHP-based system is an extremely lean, focused, and powerful solution for static documentation. By adhering to the "stupid-simple" principles of no tags, no links, and no Python, it strips away the typical bloat and dependencies found in larger generators like MkDocs, Zola, or Hugo. Unlike GitHub, it is much less complex for casual readership use.

The Restorer

The Restorer by William Verplanck Birney| Public domain painting - free to use, no copyright restrictions - Picryl description

🌟 Key Achievements of this Codebase

Principle Static Generator Solution Benefit
No Python/Node Uses pure, universal PHP and client-side JavaScript. Zero dependency chain, minimal overhead, easier deployment on nearly any shared host.
No Complex Build Process Dynamic rendering of Markdown on request (or simple static HTML generation if cached) combined with a single-run PHP index builder. Instant content updates, no long build times for 300+ files.
No Links / No Tags Client-side, full-text search is the primary navigation tool, backed by the menu's manual folder structure. Minimal content maintenance; authors only focus on writing Markdown.
Clean Design Simple, focused HTML/CSS with two-class structure for folder expansion (is-open). Fast loading, easy to audit, highly maintainable.

This project demonstrates that simplicity and function can, and should be employed when managing a large corpus of text documentation.

🛠️ Installation and Maintenance Guide

The system is designed for minimal maintenance. All configuration happens inside the main PHP files.

1. Deployment (Installation)

  1. Server Requirement: Ensure your web server has PHP 7.0 or newer.
  2. File Placement: Upload the following files and folders to your web root:
    • index.php (The main application)
    • generate_index.php (The search index builder)
    • lib/ (Containing Parsedown.php)
    • content/ (Containing all your .md files in their final folder structure)
  3. Run Indexer: Navigate to the generate_index.php file in your browser (yourdomain.com/generate_index.php). This process scans the content/ folder and creates two files: the search_index.json file (for client-side user search) and the knowledge_manifest.json file (a hierarchical summary optimized for AI consumption).
  4. Clean Up: Once the index files are successfully created, delete generate_index.php from the server.

2. Authoring Content

3. Maintenance (Updating Content)

  1. Add/Edit/Delete Files: Make changes directly to the .md files in the content/ folder.
  2. Update Index Files: Whenever you add, delete, or significantly change the content of a file, you must re-run the index builder. This updates both the user search index and the AI knowledge manifest. Upload the generate_index.php file, visit it in your browser, and then delete it again.

⚖️ Licensing and Credits

Design & Layout developed by Mark Rabideau. Primary Code Development by Gemini (Google).

All materials licensed: CC BY-ND 4.0 by eirenicon llc.