Add source-owned note transport docs#87
Merged
Merged
Conversation
This was referenced May 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds source-owned Note Transport docs under
docs/external/srcand fixes the Docker Compose persistence path used by the node preview stack.What changed
make bookto point contributors at the docs-repo ingestion workflow instead of the removed mdBook path.--database-url /app/data/node.dbin Docker Compose so the mountednode_datavolume 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/docsingest the pages intodocs.miden.xyz.Verification
docker compose -f bin/node/docker/docker-compose.yml --project-directory . configbin/node/docker/Dockerfile--database-url /app/data/node.db: node started, gRPC port opened, migrations ran, and the SQLitenotestable was createdgit diff --checkNotes
cargo fmt --checkcurrently fails on pre-existing Rust formatting drift outside this docs/Docker change.