The open-source documentation site for Scalekit — the enterprise auth platform for B2B SaaS teams.
Built with Astro + Starlight. Deployed on Netlify. Contributions very welcome.

📖 Read the Docs  ·  🐛 Report an Issue  ·  💬 Join our Slack

---

This repository is the source for docs.scalekit.com — the official developer documentation for Scalekit, a complete auth stack for AI apps; be it SSO, SCIM, MCP, Agents or full-stack authentication.

Everything here — pages, guides, API references, SDK code examples, architecture concepts — lives as MDX files, rendered by the Astro + Starlight framework, and deployed continuously on Netlify. If you spot something wrong, incomplete, or missing, a pull request is always welcome.

---

Features

• Multi-language SDK examples — every code sample covers Node.js, Python, Go, and Java
• Interactive API Reference — powered by Scalar, rendered live from the OpenAPI spec
• Full-text search + AI Ask — via Algolia DocSearch with conversational AI mode
• Diagram-as-code — architecture diagrams authored in D2 and rendered at build time
• LLMs.txt support — machine-readable docs index for AI assistants and agents
• Edit on GitHub — every published page links directly back to its source MDX file
• Dark / Light mode — with per-session persistence across page navigations

---

Project structure

developer-docs/
├── src/
│   ├── content/         # All MDX documentation pages
│   ├── components/      # Astro, React, and Vue UI components
│   ├── configs/         # Sidebar, redirects, and LLMs.txt config
│   └── styles/          # Global CSS and theme overrides
├── public/              # Static assets — images, favicons, JS widgets
├── netlify/             # Netlify serverless edge functions
├── scripts/             # Build-time utilities (search indexing, git hooks)
├── docs/                # Internal contributor reference documentation
├── astro.config.mjs     # Astro + Starlight site configuration
└── package.json

---

Getting started

Prerequisites

• Node.js ≥ 18
• pnpm ≥ 10

npm install -g pnpm

Run locally

# 1. Clone the repository
git clone https://github.com/scalekit-inc/developer-docs.git
cd developer-docs

# 2. Install dependencies
pnpm install

# 3. Start the dev server
pnpm dev

Open http://localhost:4321. Changes to MDX files hot-reload instantly.

Useful Commands

Command	Description
pnpm dev	Start the local dev server (no HMR)
pnpm build	Build the production site to ./dist
pnpm preview	Preview the production build locally
pnpm format	Auto-format all .md, .mdx, .astro, .ts files
pnpm format:check	Check formatting without writing changes
pnpm generate-search-index	Regenerate the Algolia API search index

---

✍️ Contributing

We welcome contributions from everyone — whether it's fixing a typo, improving a code example, clarifying a concept, or adding a missing guide.

Quick Contribution Flow

1. Fork this repository and clone it locally
2. Create a branch — git checkout -b fix/my-improvement
3. Edit the relevant MDX files inside src/content/
4. Format your changes — pnpm format
5. Open a Pull Request — every page has an "Edit this page" link that takes you directly to the right file

Writing Standards

Before writing or editing, check two files:

• CLAUDE.md — quick reference for voice, structure, and document types
• .cursorrules — detailed style, formatting, and content rules

Key conventions at a glance:

• Write in second person — "you", "your application"
• Use present tense for descriptions, imperative for instructions
• Every page needs title, description, sidebar.label, and tags in its frontmatter
• Code examples must cover all 4 SDK languages using <Tabs syncKey="tech-stack">

---

🧰 Tech Stack

Layer	Technology
Framework	Astro v5
Docs theme	Starlight
UI components	React 19, Vue 3
Styling	Tailwind CSS v4
API Reference	Scalar
Search	Algolia DocSearch + AI Ask
Diagrams	D2 via astro-d2
Deployment	Netlify (SSR, Edge Functions)
Package manager	pnpm v10
Formatting	Prettier + simple-git-hooks

---

🌐 Deployment

The site runs in SSR mode on Netlify with Edge Functions. Every push to main triggers a production deploy. Pull requests automatically generate isolated preview deployments.

# Netlify build command
bash scripts/install-d2.sh && export PATH="$HOME/.local/bin:$PATH" && pnpm run build

Environment variables required for local development are documented in .env.example.

---

📄 License

This project is licensed under the MIT License. See LICENSE for the full text.

---

🤝 Community & Support

Have a question, idea, or just want to talk developer tooling? Come find us:

• 💬 Slack community — Join the Scalekit Community
• 🐛 Bug reports & feature requests — GitHub Issues
• 🌐 Live docs — docs.scalekit.com
• 🏠 Scalekit website — scalekit.com

---

_{Built with ❤️ by the Scalekit team and open-source contributors.}