Skip to content

Add Docusaurus documentation#85

Open
Dominik1999 wants to merge 1 commit intomainfrom
dominik1999-claude/docs
Open

Add Docusaurus documentation#85
Dominik1999 wants to merge 1 commit intomainfrom
dominik1999-claude/docs

Conversation

@Dominik1999
Copy link
Copy Markdown
Contributor

Summary

  • Set up Docusaurus matching the miden-base documentation pattern
  • Four documentation pages:
    • Overview: what the NTL is, why it exists, key properties
    • Design: note flow, tag routing, cursor pagination, streaming, block context, storage
    • For operators: installation, CLI flags, env vars, Docker Compose telemetry stack, monitoring, logging
    • For users: gRPC API reference, client integration pattern, cursor management, troubleshooting
  • Updated Makefile book target from mdbook to Docusaurus
  • Added .node-version (22) for compatibility

Test plan

  • cd docs && npm install && npm run start:dev serves locally (requires Node 22)
  • All 4 pages render correctly with sidebar navigation
  • make lint passes (no Rust changes)

🤖 Generated with Claude Code

Closes #76

Set up Docusaurus matching miden-base pattern with four pages:
- Overview: what the NTL is and why it exists
- Design: note flow, tag routing, cursor pagination, streaming, storage
- For operators: installation, CLI flags, env vars, Docker, monitoring
- For users: gRPC API reference, client integration, troubleshooting

Update Makefile book target to use Docusaurus instead of mdbook.

Closes #76

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@Dominik1999 Dominik1999 added this to the Release v0.4.0 milestone Apr 24, 2026
@Dominik1999 Dominik1999 marked this pull request as ready for review April 24, 2026 09:45
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.

Documentation

2 participants