wmantly
b78376cdf9
- Added ORM reference in architecture.md (Redis section) - Added Data Models section in contributing.md with example - Updated README.md to mention model-redis in Architecture - Linked to https://www.npmjs.com/package/model-redis for more info 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Documentation
This directory contains the GitHub Pages documentation site for the Proxy project.
Live site: https://theta42.github.io/proxy/
Pages
index.md- Home page with project overviewinstallation.md- Installation and setup guideapi.md- Complete API referencearchitecture.md- System architecture and designcontributing.md- Development and contribution guide
Local Preview
To preview the site locally:
# Install Jekyll (one-time setup)
gem install jekyll bundler
# Run local server
cd docs
jekyll serve
# View at http://localhost:4000/proxy/
Theme
The site uses the Cayman theme (jekyll-theme-cayman). Configuration is in _config.yml.
Updating Documentation
- Edit markdown files in this directory
- Commit and push to master branch
- GitHub Pages automatically rebuilds (may take 1-2 minutes)
- Changes visible at https://theta42.github.io/proxy/
Legacy Documentation
dev_setup.md- Old development setup notes (kept for reference)Update 4.11.md- Old update notes (kept for reference)