Skip to content

CLAUDE.md

Latest commit

 

History

History
93 lines (68 loc) · 1.82 KB

CLAUDE.md

File metadata and controls

93 lines (68 loc) · 1.82 KB
Raw

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

Keyway Docs is the documentation site for Keyway, built with Docusaurus 3. Hosted at docs.keyway.sh.

Development Commands

pnpm install          # Install dependencies
pnpm start            # Dev server (localhost:3000)
pnpm run build        # Production build
pnpm run serve        # Serve built site locally
pnpm run clear        # Clear Docusaurus cache

Architecture

Directory Structure

docs/
├── intro.md          # Getting started (landing page)
├── installation.md   # Installation guide
├── cli.md            # CLI reference
├── api.md            # API reference
├── ci-cd.md          # CI/CD integration
├── mcp.md            # MCP Server for AI tools (9 tools)
├── ai-agents.md      # AI agents integration (keyway run)
├── security.md       # Security & permissions
├── organizations.md  # Organizations & billing
└── integrations.md   # Provider integrations (Vercel, etc.)

Configuration

  • docusaurus.config.ts - Site config, navbar, footer
  • sidebars.ts - Documentation sidebar structure

Writing Documentation

Frontmatter

---
sidebar_position: 1
title: Page Title
---

# Page Title

Content here...

Admonitions

:::tip Title
Helpful tip content
:::

:::caution
Warning content
:::

Code Blocks

```bash
keyway push -e production
```

```typescript title="example.ts"
const vault = await api.getVault(owner, repo);
```

Internal Links

Use relative paths:

See [API Reference](./api) for details.

Building

pnpm run build

Build output goes to build/ directory. Broken links cause build failure (strict mode).