How eka-care/eka-docs works
Project type and purpose
• This is a *static documentation website* built with the Mintlify framework.
• Its purpose is to organize and publish developer documentation (SDK guides, API references, cookbooks, user guides, etc.) for the EKA platform.
File structure
• Top‐level files:
• mint.json – Mintlify site configuration
• README.md – how to develop and deploy
• .gitignore
• Content directories (each holds .mdx, .yaml, .yml):
• SDKs/ – platform-specific SDK guides (Android, iOS, web, backend)
• api-reference/ – REST/API docs organized by domain
• cookbook/ – “what’s possible” recipe guides
• eka-medai/, eka-sdk/, essentials/, user-guides/ – thematic documentation sections
• images/, logo/ – static assets
• snippets/ – reusable code snippets
• No “frontend/” or “backend/” code directories: the entire repo is content for static‐site generation.
README for additional insights
• Uses the Mintlify CLI (mintlify dev) to preview locally.
• Uses a GitHub App for CI/CD: on push to default branch, docs get built and deployed automatically.
• Deployment target is the Mintlify hosting platform (behind a CDN).
Detail reminder
• Every major piece: content folders, the build tool, CI/CD trigger, hosting layer.
• Even though it’s a simple static-site flow, diagramming each component makes the architecture crystal clear.