Skip to content

feat: add Mintlify documentation site#11

Merged
pilotspacex-byte merged 1 commit into
mainfrom
feat/docs
Mar 28, 2026
Merged

feat: add Mintlify documentation site#11
pilotspacex-byte merged 1 commit into
mainfrom
feat/docs

Conversation

@TinDang97

Copy link
Copy Markdown
Collaborator

Summary

  • Set up a complete Mintlify docs site in docs/ with maple theme and indigo color scheme
  • Created 10 documentation pages covering all major areas: quickstart, architecture, configuration, command reference, benchmarks, and guides for persistence, clustering, TLS, and Docker
  • Generated logo (light/dark) and favicon assets via Gemini image generation

Pages

Page Description
index.mdx Landing page with key metrics and feature cards
quickstart.mdx Build from source, Docker, client library examples
architecture.mdx Thread-per-core design, DashTable, memory layout
commands.mdx All 200+ supported commands by data type
configuration.mdx All CLI flags with production example
benchmarks.mdx Full performance data with reproduction steps
guides/persistence.mdx AOF, RDB, per-shard WAL
guides/clustering.mdx Replication, cluster mode, failover
guides/tls.mdx TLS 1.3, mTLS setup
guides/docker.mdx Container deployment patterns

Test plan

  • Run cd docs && mint dev with Node 22 and verify all pages render
  • Verify navigation structure matches docs.json
  • Check internal links resolve correctly (mint broken-links)
  • Verify logos and favicon display in light/dark modes

Set up a complete docs site with Mintlify covering architecture,
configuration, commands, benchmarks, and operational guides for
persistence, clustering, TLS, and Docker deployment.
@pilotspacex-byte pilotspacex-byte self-requested a review March 28, 2026 02:35
@pilotspacex-byte pilotspacex-byte merged commit 1eca6bc into main Mar 28, 2026
5 of 6 checks passed
@pilotspacex-byte pilotspacex-byte deleted the feat/docs branch March 28, 2026 02:35
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.

2 participants