Documentation System

Setup and usage guide for our Jekyll-based documentation system.

Prerequisites

• Ruby (2.7 or higher recommended)
• RubyGems
• Bundler

Initial Setup

1. Install Jekyll and dependencies

   gem install jekyll bundler
   bundle install
   

2. Install project dependencies

   bundle install
   

Local Preview

1. Start the Jekyll server

   bundle exec jekyll serve
   

2. Access the documentation
   • Open your browser to http://localhost:4000
   • Changes to markdown files will automatically rebuild
   • Refresh your browser to see updates

To stop the server, press Ctrl+C in the terminal.

Troubleshooting

SSL Certificate Issues

If you encounter SSL certificate errors with bundler:

bundle config set --local ssl_verify_mode 0

Port Already in Use

If port 4000 is already in use, specify a different port:

bundle exec jekyll serve --port 4001

Writing Documentation

• Place new markdown files in the appropriate subdirectory under docs/
• Use front matter to set page metadata
• Follow the existing naming and hierarchy conventions