selfhostblocks/docs/manual.md
ak2k 16fcec4d40 feat: add documentation infrastructure and service implementation guide
## Documentation Infrastructure & Service Implementation Guide

This PR introduces documentation tooling and contributor resources to help maintain and expand the SelfHostBlocks project:

### Service Implementation Guide
- Add comprehensive guide for implementing new SHB services
- Covers contracts, testing, documentation, and integration patterns
- Provides step-by-step instructions and best practices for contributors

### Redirect Management Tool
- Add automated update-redirects tool to maintain documentation links
- Extracts heading IDs from markdown files across docs/, modules/, demo/
- Maps source files to target HTML pages using project routing logic
- Generates missing redirects in format expected by nixos-render-docs
2025-06-08 01:28:07 +02:00

41 lines
776 B
Markdown

<!-- Read these docs at https://shb.skarabox.com -->
# Self Host Blocks Manual {#self-host-blocks-manual}
## Version @VERSION@
```{=include=} preface
preface.md
```
```{=include=} chapters html:into-file=//usage.html
usage.md
```
```{=include=} chapters html:into-file=//services.html
services.md
```
```{=include=} chapters html:into-file=//contracts.html
contracts.md
```
```{=include=} chapters html:into-file=//blocks.html
blocks.md
```
```{=include=} chapters html:into-file=//demos.html
demos.md
```
```{=include=} chapters html:into-file=//contributing.html
contributing.md
```
```{=include=} chapters html:into-file=//service-implementation-guide.html
service-implementation-guide.md
```
```{=include=} appendix html:into-file=//options.html
options.md
```