Skip to content

Commit 70cf58f

Browse files
ravisuhagravisuhag
committed
docs: migrate from Docusaurus to Chronicle
Replace Docusaurus setup with Chronicle, a config-driven documentation framework. Single chronicle.yaml replaces docusaurus.config.js, sidebars.js, and custom components. Vercel build uses npx @raystack/chronicle directly with no package.json needed, matching the Frontier docs pattern.
1 parent cea0efa commit 70cf58f

31 files changed

Lines changed: 264 additions & 9637 deletions

‎docs/babel.config.js‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎docs/chronicle.yaml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
title: Compass
2+
description: Context engine for organizational metadata
3+
4+
theme:
5+
name: default
6+
7+
navigation:
8+
links:
9+
- label: GitHub
10+
href: https://github.com/raystack/compass
11+
12+
search:
13+
enabled: true
14+
placeholder: Search docs...
15+
16+
llms:
17+
enabled: true
18+
19+
footer:
20+
copyright: "Raystack"
21+
links:
22+
- label: GitHub
23+
href: https://github.com/raystack/compass

docs/docs/concepts/architecture.md renamed to docs/docs/concepts/architecture.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1+
---
2+
title: Architecture
3+
description: System design and component architecture of the Compass context engine.
4+
order: 2
5+
---
6+
17
# Architecture
28

39
Compass is built as a context engine with a layered architecture. Raw metadata observations flow in, get resolved into unified entities, are stored in a temporal knowledge graph, indexed for hybrid search, and served to both human interfaces and AI agents.
410

5-
![Compass Architecture](/assets/architecture.png)
11+
![Compass Architecture](./architecture.png)
612

713
## System Design
814

docs/static/assets/architecture.png renamed to docs/docs/concepts/architecture.png

File renamed without changes.

docs/docs/concepts/internals.md renamed to docs/docs/concepts/internals.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Internals
3+
description: Search architecture, storage internals, and multi-tenancy model.
4+
order: 3
5+
---
6+
17
# Internals
28

39
This document details how Compass works under the hood. It covers the search architecture, storage internals, and multi-tenancy model.

‎docs/docs/concepts/overview.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Overview
3+
description: Core concepts and features of the Compass context engine.
4+
order: 1
5+
---
6+
17
# Overview
28

39
Compass is a context engine that builds a knowledge graph of your organization's metadata, capturing entities, relationships, and lineage across systems and time, making it discoverable and queryable for both humans and AI agents.

docs/docs/configuration.md renamed to docs/docs/configuration.mdx

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Configuration
3+
description: Configure the Compass server and CLI client.
4+
order: 3
5+
---
6+
17
# Configuration
28

39
Compass binary contains both the CLI client and the server. Each has its own configuration in order to run. Server configuration contains information such as database credentials, log severity, search backend settings, etc. while CLI client configuration only has configuration about which server to connect.
@@ -34,7 +40,7 @@ Set up the Postgres database (with pgvector and pg_trgm extensions) and provide
3440
3541
Following is a sample server configuration yaml:
3642

37-
```yaml title="compass.yaml"
43+
```yaml
3844
log_level: info # debug|info|warning|error|fatal|trace|panic - default: info
3945

4046
db:
@@ -58,9 +64,9 @@ service:
5864
5965
All the server configurations can be passed as environment variables using underscore \_ as the delimiter between nested keys.
6066
61-
See [configuration reference](./reference/configuration.md) for the list of all the configuration keys.
67+
See [configuration reference](./reference/configuration) for the list of all the configuration keys.
6268
63-
```sh title=".env"
69+
```sh
6470
LOG_LEVEL=info
6571
DB_HOST=localhost
6672
DB_PORT=5432
@@ -184,7 +190,7 @@ The following table lists the configurable parameters of the Compass chart and t
184190

185191
See full helm values guide [here](https://github.com/raystack/charts/tree/main/stable/compass#values)
186192

187-
```yaml title="values.yaml"
193+
```yaml
188194
app:
189195
image:
190196
repository: raystack/compass

docs/docs/contribute/contributing.md renamed to docs/docs/contribute/contributing.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Contributing
3+
description: How to become a contributor and contribute to Compass.
4+
order: 1
5+
---
6+
17
# Contribution Process
28

39
## BECOME A COMMITOR & CONTRIBUTE
@@ -31,4 +37,3 @@ Please follow these practices for your changes to get merged faster:
3137
* Make sure your local build is running with all the tests and checkstyle passing.
3238
* If your change is related to user-facing protocols / configurations, you need to make the corresponding change in the documentation as well.
3339
* Docs live in the code repo under `docs` so that changes to that can be done in the same PR as changes to the code.
34-

docs/docs/contribute/development-guide.md renamed to docs/docs/contribute/development-guide.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Development Guide
3+
description: Build, test, and run Compass locally for development.
4+
order: 2
5+
---
6+
17
# Development Guide
28

39
This guide is intended for developers who want to contribute to Compass. It contains information on how to build, test and run Compass locally.
@@ -6,8 +12,8 @@ This guide is intended for developers who want to contribute to Compass. It cont
612

713
Dependencies:
814

9-
- Compass is written in Golang, and requires go version >= 1.25. Please make sure that the go toolchain is available on your machine. See Golang’s [documentation](https://golang.org/) for installation instructions. Alternatively, you can use docker to build Compass as a docker image. More on this in the next section.
10-
- Compass uses PostgreSQL (with pgvector and pg_trgm extensions) as its sole storage for the knowledge graph, entity data, and all search indexes. There are no external search engine dependencies. In order to run Compass locally, you’ll need to have an instance of Postgres running. You can either download it and run it manually, or you can run it inside Docker by using `docker-compose` with `docker-compose.yaml` provided in the root of this project.
15+
- Compass is written in Golang, and requires go version >= 1.25. Please make sure that the go toolchain is available on your machine. See Golang's [documentation](https://golang.org/) for installation instructions. Alternatively, you can use docker to build Compass as a docker image. More on this in the next section.
16+
- Compass uses PostgreSQL (with pgvector and pg_trgm extensions) as its sole storage for the knowledge graph, entity data, and all search indexes. There are no external search engine dependencies. In order to run Compass locally, you'll need to have an instance of Postgres running. You can either download it and run it manually, or you can run it inside Docker by using `docker-compose` with `docker-compose.yaml` provided in the root of this project.
1117
- PostgreSQL details can be specified via environment variables: `DB_HOST`, `DB_NAME`, `DB_USER`, `DB_PASSWORD`.
1218
- If you use Docker to build Compass, then configuring networking requires extra steps. Following is one way of doing it by running Postgres inside with `docker-compose` first.
1319

docs/docs/introduction.md renamed to docs/docs/index.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
id: introduction
3-
slug: /
2+
title: Introduction
3+
description: Welcome to the introductory guide to Compass, a context engine for organizational metadata.
4+
order: 1
45
---
56

67
# Introduction
@@ -13,7 +14,7 @@ Compass is a context engine that builds a knowledge graph of your organization's
1314

1415
Critical organizational knowledge lives scattered across dozens of systems: services, datasets, applications, teams, configurations, decisions, and the relationships between them. Compass resolves observations from these sources into unified entities, constructs a temporal graph of their relationships, and indexes everything for both keyword and semantic search. The result is a context graph that stitches together what exists, who owns it, how it connects, and what changed over time, so both humans and AI agents can discover, traverse, and reason over the full picture.
1516

16-
![](/assets/overview.svg)
17+
![Compass Overview](./overview.svg)
1718

1819
## The Problem
1920

@@ -39,11 +40,11 @@ You can interact with Compass in any of the following ways:
3940

4041
### Command Line Interface
4142

42-
You can use the Compass command line interface to issue commands and manage the server. Using the command line can be faster and more convenient than the console. For more information on using the Compass CLI, see the [CLI Reference](./reference/cli.md) page.
43+
You can use the Compass command line interface to issue commands and manage the server. Using the command line can be faster and more convenient than the console. For more information on using the Compass CLI, see the [CLI Reference](./reference/cli) page.
4344

4445
### HTTP and gRPC APIs
4546

46-
Compass provides HTTP and gRPC APIs for programmatic access. The API is built with [Connect RPC](https://connectrpc.com/) and supports both Connect and gRPC protocols. For more information, see the [API reference](./reference/api.md) page.
47+
Compass provides HTTP and gRPC APIs for programmatic access. The API is built with [Connect RPC](https://connectrpc.com/) and supports both Connect and gRPC protocols. For more information, see the [API reference](./reference/api) page.
4748

4849
### MCP Server
4950

0 commit comments

Comments
 (0)