README.md

eRxbox Documentation

Documentation for eRxbox — Electronic prescribing and medication management.

Prerequisites

• Bun installed

Setup

bun install

This installs docs-tools and sets up a pre-push git hook that runs lint before every push.

Commands

bun lint                       # run all doc checks
bun lint:check broken-links    # run a single check
bun images:check               # find unoptimized images
bun images:optimize            # convert to AVIF + update refs

Structure

docs/           # Markdown documentation files
assets/         # Images and other assets
SUMMARY.md      # Navigation structure
redirects.yaml  # URL redirects

Contributing

1. bun install (once, sets up tools + pre-push hook)
2. Edit markdown files in docs/
3. Update SUMMARY.md if adding new pages
4. bun lint to check before pushing
5. Submit a pull request

CI runs lint automatically on PRs. Image optimization runs on push to main.