Skip to content

Add source-owned note transport docs#87

Merged
BrianSeong99 merged 2 commits into
mainfrom
brian/note-transport-external-docs
May 14, 2026
Merged

Add source-owned note transport docs#87
BrianSeong99 merged 2 commits into
mainfrom
brian/note-transport-external-docs

Conversation

@BrianSeong99
Copy link
Copy Markdown
Contributor

Summary

Adds source-owned Note Transport docs under docs/external/src and fixes the Docker Compose persistence path used by the node preview stack.

What changed

  • Adds overview, design, operator, and user docs for the note transport service.
  • Documents the current gRPC API, cursor model, retention/storage behavior, telemetry env vars, and current block-context limitations.
  • Updates make book to point contributors at the docs-repo ingestion workflow instead of the removed mdBook path.
  • Passes --database-url /app/data/node.db in Docker Compose so the mounted node_data volume is actually used, and removes the non-existent HTTP health port mapping.

Why

PR #85 added a standalone Docusaurus app and included docs that drifted from the current implementation. This keeps the source of truth in the service repo while letting 0xMiden/docs ingest the pages into docs.miden.xyz.

Verification

  • docker compose -f bin/node/docker/docker-compose.yml --project-directory . config
  • Docker image build from bin/node/docker/Dockerfile
  • Container runtime smoke test with --database-url /app/data/node.db: node started, gRPC port opened, migrations ran, and the SQLite notes table was created
  • git diff --check

Notes

cargo fmt --check currently fails on pre-existing Rust formatting drift outside this docs/Docker change.

@BrianSeong99 BrianSeong99 merged commit 9750634 into main May 14, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant