Skip to content

Commit e2afc72

Browse files
committed
docs: comprehensive documentation overhaul for public release
Add 14 documentation guides covering all aspects of the registry: - Getting started, installation, and configuration reference - Storage backends (PostgreSQL, MySQL, Cassandra, memory) - Schema types (Avro, Protobuf, JSON Schema) with references - Compatibility modes, migration from Confluent, deployment - Authentication (6 methods), security hardening, RBAC - Monitoring (Prometheus metrics, alerting, Grafana) - Development guide, troubleshooting, and error code reference Add auto-generated API reference from OpenAPI spec: - docs/api-reference.md (markdown, 7002 lines via widdershins) - docs/api/index.html (ReDoc interactive HTML) - scripts/generate-api-docs.sh for regeneration - GitHub Actions workflow (workflow_dispatch) for CI generation Rebuild README.md as a focused landing page with feature comparison table, architecture diagrams, and documentation index.
1 parent a73ecb7 commit e2afc72

20 files changed

+14594
-933
lines changed

.github/workflows/docs-api.yaml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Generate API Documentation
2+
3+
on:
4+
workflow_dispatch:
5+
6+
permissions:
7+
contents: write
8+
9+
jobs:
10+
generate-docs:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v4
15+
16+
- name: Setup Node.js
17+
uses: actions/setup-node@v4
18+
with:
19+
node-version: '20'
20+
21+
- name: Generate API documentation
22+
run: ./scripts/generate-api-docs.sh
23+
24+
- name: Check for changes
25+
id: changes
26+
run: |
27+
git diff --quiet docs/api-reference.md docs/api/index.html && echo "changed=false" >> "$GITHUB_OUTPUT" || echo "changed=true" >> "$GITHUB_OUTPUT"
28+
29+
- name: Commit and push
30+
if: steps.changes.outputs.changed == 'true'
31+
run: |
32+
git config user.name "github-actions[bot]"
33+
git config user.email "github-actions[bot]@users.noreply.github.com"
34+
git add docs/api-reference.md docs/api/index.html
35+
git commit -m "docs: regenerate API reference from OpenAPI spec"
36+
git push

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ config.local.yaml
3232
.env
3333
.env.local
3434

35-
# Generated API documentation
36-
docs/api/
35+
# Generated API documentation (committed; regenerate with: make docs-api)
36+
# docs/api/
3737

3838
# Debug
3939
debug

Makefile

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -480,12 +480,9 @@ docker-build:
480480
docker-run:
481481
docker run -p 8081:8081 axonops/schema-registry:latest
482482

483-
## Generate static API documentation (requires npx)
483+
## Generate API documentation from OpenAPI spec (markdown + ReDoc HTML)
484484
docs-api:
485-
@echo "Generating static API documentation..."
486-
@mkdir -p docs/api
487-
npx @redocly/cli build-docs api/openapi.yaml -o docs/api/index.html
488-
@echo "Documentation generated at docs/api/index.html"
485+
@./scripts/generate-api-docs.sh
489486

490487
## Clean build artifacts
491488
clean:
@@ -552,5 +549,5 @@ help:
552549
@echo " fmt Format code"
553550
@echo " run Build and run the server"
554551
@echo " dev Run with hot reload (requires air)"
555-
@echo " docs-api Generate static API documentation"
552+
@echo " docs-api Generate API docs from OpenAPI (markdown + HTML)"
556553
@echo " clean Clean build artifacts"

0 commit comments

Comments
 (0)