|
1 | 1 | # MDMbox Documentation |
2 | 2 |
|
3 | | -This repository contains the documentation for [MDMbox](https://www.health-samurai.io/mdmbox) - Master data management for healthcare organizations. |
| 3 | +Documentation for [MDMbox](https://www.health-samurai.io/mdmbox) — Master data management for healthcare organizations. |
4 | 4 |
|
5 | | -## Structure |
| 5 | +## Prerequisites |
| 6 | + |
| 7 | +- [Bun](https://bun.sh) installed |
| 8 | + |
| 9 | +## Setup |
6 | 10 |
|
| 11 | +```bash |
| 12 | +bun install |
7 | 13 | ``` |
8 | | -mdmbox-docs/ |
9 | | -├── docs/ # Markdown documentation files |
10 | | -├── assets/ # Images and other assets |
11 | | -├── SUMMARY.md # Navigation structure |
12 | | -└── redirects.yaml # URL redirects |
| 14 | + |
| 15 | +This installs [docs-tools](https://github.com/HealthSamurai/docs-tools) and sets up a pre-push git hook that runs lint before every push. |
| 16 | + |
| 17 | +## Commands |
| 18 | + |
| 19 | +```bash |
| 20 | +bun lint # run all doc checks |
| 21 | +bun lint:check broken-links # run a single check |
| 22 | +bun images:check # find unoptimized images |
| 23 | +bun images:optimize # convert to AVIF + update refs |
13 | 24 | ``` |
14 | 25 |
|
15 | | -## Local Development |
| 26 | +## Structure |
16 | 27 |
|
17 | | -Documentation is rendered by the [health-samurai.io](https://health-samurai.io) portal. |
| 28 | +``` |
| 29 | +docs/ # Markdown documentation files |
| 30 | +assets/ # Images and other assets |
| 31 | +SUMMARY.md # Navigation structure |
| 32 | +redirects.yaml # URL redirects |
| 33 | +``` |
18 | 34 |
|
19 | 35 | ## Contributing |
20 | 36 |
|
21 | | -1. Edit markdown files in `docs/` |
22 | | -2. Update `SUMMARY.md` if adding new pages |
23 | | -3. Submit a pull request |
24 | | - |
25 | | -## License |
| 37 | +1. `bun install` (once, sets up tools + pre-push hook) |
| 38 | +2. Edit markdown files in `docs/` |
| 39 | +3. Update `SUMMARY.md` if adding new pages |
| 40 | +4. `bun lint` to check before pushing |
| 41 | +5. Submit a pull request |
26 | 42 |
|
27 | | -MIT |
| 43 | +CI runs lint automatically on PRs. Image optimization runs on push to main. |
0 commit comments