# Where to Find Documentation for Kaneo: Complete Repository Guide

> Find complete documentation for Kaneo in the usekaneo/kaneo repository within the apps/docs directory. Explore Core Guides, API Reference, and deployment instructions at kaneo.app/docs/core.

- Repository: [kaneo.app/kaneo](https://github.com/usekaneo/kaneo)
- Tags: getting-started
- Published: 2026-08-09

---

**Kaneo’s documentation lives in the `apps/docs` directory of the usekaneo/kaneo repository and is published online at `https://kaneo.app/docs/core`, offering Core Guides, API Reference, and deployment instructions.**

If you are looking for documentation for Kaneo, the open-source project management platform, you will find comprehensive guides both in the repository and hosted on the official website. The documentation source is organized as MDX files under `apps/docs` and covers installation, API integration, and deployment workflows.

## Documentation Location and Structure

### Online Documentation Site

The public documentation is hosted at `https://kaneo.app/docs/core`. The [`README.md`](https://github.com/usekaneo/kaneo/blob/main/README.md) file in the repository root directs users to this URL with the specific note: "Learn more about Kaneo's features and capabilities in our documentation."

### Repository Documentation Folder

Inside the monorepo, all documentation source files reside under `apps/docs`. This folder contains the MDX files that power the documentation site, organized into three primary sections for easy navigation.

## Core Documentation Sections

### Core Guides

The entry point at `apps/docs/index.mdx` introduces platform concepts starting with the "Why Kaneo" overview. This section provides quick-start instructions, installation guides, and functional usage documentation covering everything needed to understand the platform's capabilities and basic configuration.

### API Reference

Located at `apps/docs/api-reference/introduction.mdx`, this section provides an OpenAPI-styled description of every backend endpoint, request/response schemas, and authentication details. Individual endpoint documentation files such as `tasks/createTask.mdx` and `projects/listProjects.mdx` offer granular reference material for API consumers.

### Deployments and Integrations

This section includes step-by-step instructions for Docker Compose setups (`apps/docs/core/installation/docker-compose.mdx`), Helm charts, drim CLI usage, and third-party service integrations like GitHub (`apps/docs/core/integrations/github/setup.mdx`) and Slack.

## Running Documentation Locally

To browse the documentation for Kaneo offline or contribute changes, clone the repository and run the docs application locally. Execute the following command to serve the site:

```bash
pnpm --filter @kaneo/docs dev

```

This starts a local development server at `http://localhost:5173/docs`. Alternatively, you can open individual MDX files in any Markdown viewer to review the content directly.

## Practical Usage Examples

The documentation directly supports development workflows. Below are implementation patterns derived from the documented API schemas and deployment guides.

### Fetching Tasks via API Client

The [`apps/web/src/fetchers/tasks/get-task.ts`](https://github.com/usekaneo/kaneo/blob/main/apps/web/src/fetchers/tasks/get-task.ts) file demonstrates how to consume the API endpoints described in the documentation:

```typescript
// apps/web/src/fetchers/tasks/get-task.ts
import { apiClient } from '@/lib/api-client';

export async function getTask(taskId: string) {
  const response = await apiClient.get(`/api/tasks/${taskId}`);
  if (!response.ok) throw new Error('Failed to fetch task');
  return response.json(); // conforms to the Task schema described in docs
}

```

### Deploying with drim CLI

Following the deployment documentation, install and configure Kaneo using the drim CLI:

```bash

# Install drim and set up a Kaneo instance

curl -fsSL https://assets.kaneo.app/install.sh | sh
drim setup

```

### Creating Projects via REST API

The API reference documents the exact shape for `POST /api/projects`. Implement this endpoint using standard fetch:

```typescript
async function createProject(name: string) {
  const res = await fetch(`${process.env.KANEO_API_URL}/api/projects`, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: `Bearer ${process.env.API_TOKEN}`,
    },
    body: JSON.stringify({ name }),
  });
  if (!res.ok) throw new Error('Project creation failed');
  return await res.json(); // matches the Project schema in docs
}

```

## Summary

- **Primary Location:** Documentation for Kaneo is maintained in `apps/docs` within the usekaneo/kaneo repository and published at `https://kaneo.app/docs/core`.
- **Three Main Sections:** Core Guides (concepts and installation), API Reference (endpoints and schemas), and Deployments & Integrations (Docker, Helm, third-party services).
- **Key Files:** Entry point at `apps/docs/index.mdx`, API overview at `apps/docs/api-reference/introduction.mdx`, and Docker setup at `apps/docs/core/installation/docker-compose.mdx`.
- **Local Development:** Run `pnpm --filter @kaneo/docs dev` to serve documentation locally at `http://localhost:5173/docs`.

## Frequently Asked Questions

### Where is the documentation for Kaneo hosted online?

The official documentation is published at `https://kaneo.app/docs/core`. This site renders the MDX files stored in the repository's `apps/docs` folder and provides searchable access to all Core Guides, API references, and deployment instructions.

### How do I run the Kaneo documentation locally?

Clone the usekaneo/kaneo repository and execute `pnpm --filter @kaneo/docs dev` from the project root. This command starts a local development server at `http://localhost:5173/docs`, allowing you to preview changes or browse documentation offline.

### What sections are included in the Kaneo documentation?

The documentation is organized into three main sections: **Core Guides** covering installation and platform usage, **API Reference** detailing every backend endpoint with request/response schemas, and **Deployments & Integrations** providing instructions for Docker Compose, Kubernetes Helm charts, and third-party services like GitHub and Slack.

### How do I integrate with the Kaneo API using the documentation?

The API Reference section provides OpenAPI-styled specifications for all endpoints. Use the documented request schemas to construct API calls, as shown in the [`apps/web/src/fetchers/tasks/get-task.ts`](https://github.com/usekaneo/kaneo/blob/main/apps/web/src/fetchers/tasks/get-task.ts) example, which implements the task retrieval endpoint exactly as specified in the reference documentation.