Skip to content

Commit e4988b2

Browse files
committed
fix: resolve broken doc links and update concepts overview
1 parent 5366c97 commit e4988b2

4 files changed

Lines changed: 36 additions & 34 deletions

File tree

docs/docs/concepts/overview.mdx

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
11
# Overview
22

3-
Compass has three major concept when it comes to data ingestion: Asset, Type, and Service.
4-
5-
Asset is the main model that represents a metadata of a specific service with a specific type.
6-
7-
Type defines a ‘type’ of an asset and it is pre-defined. Compass currently supports the following types:
8-
1. `table`
9-
2. `job`
10-
3. `dashboard`
11-
4. `topic`
12-
5. `feature_table`
13-
6. `model` (under development)
14-
7. `application` (under development)
15-
16-
Service defines the application or source that maintains or generates the asset. Examples would be `biquery`, `postgres`, etc.
17-
18-
Some features that compass has:
19-
* [Discovery](../tour/2-querying-assets.mdx)
20-
* [Lineage](../tour/3-asset-lineage.mdx)
21-
* [Asset Tagging](./asset#tagging-an-asset)
22-
* [User](./user.md)
23-
* [Discussion](../guides/discussion.md)
24-
* [Starring](../guides/starring.md)
25-
26-
## Discussion
27-
Compass supports discussion feature. User could drop comments in each discussion. Currently, there are three types of discussions `issues`, `open ended`, and `question and answer`. Depending on the type, the discussion could have multiple possible states. In the current version, all types only have two states: `open` and `closed`. A newly created discussion will always be assign an `open` state. More detail about [Discussion](../guides/discussion.md).
28-
29-
## Starring
30-
Compass allows a user to stars an asset. This bookmarking functionality is introduced to increase the speed of a user to get information. There is also an API to see which users star an asset (stargazers). More detail about [Starring](../guides/starring.md).
3+
Compass is an organizational context engine that builds a temporal entity graph of your systems and serves it to AI agents via MCP.
4+
5+
## Core Concepts
6+
7+
**Entity** is the core domain object — anything worth naming in your organization's knowledge graph: a table, service, pipeline, satellite, person, decision, etc. Entities have an open type system — any non-empty string is a valid type.
8+
9+
**Edge** is a typed, directed, temporal relationship between two entities. Lineage, ownership, and other relationships are all modeled as edges.
10+
11+
**Chunk** is a text fragment with a vector embedding for semantic search. Chunks are derived from entities — they're an indexing mechanism, not knowledge.
12+
13+
## Features
14+
15+
- **Entity Graph**: Temporal entities with typed edges and properties (JSONB)
16+
- **Search**: Keyword (tsvector), semantic (pgvector), and hybrid (RRF fusion)
17+
- **Context Assembly**: `get_context` builds a subgraph around any entity
18+
- **Impact Analysis**: `impact` traces downstream blast radius
19+
- **MCP Tools**: AI agents query the graph via MCP protocol
20+
- **Stars**: Users can star entities for quick access
21+
22+
## Architecture
23+
24+
All search is Postgres-native — no Elasticsearch dependency:
25+
26+
| Mode | Engine | Purpose |
27+
|---|---|---|
28+
| Keyword | tsvector + pg_trgm | Exact matches, fuzzy/typo tolerance |
29+
| Semantic | pgvector cosine | Conceptual/natural language |
30+
| Hybrid | Both + RRF fusion | Best of both |
31+
32+
Schema: `namespaces``users``entities``edges``chunks``stars`

docs/docs/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -269,9 +269,9 @@ client:
269269
270270
#### Required Header/Metadata in API
271271
272-
Compass has a concept of [User](./concepts/user.md). In the current version, all APIs in Compass require an identity header in the request. The header key is configurable but the default name is `Compass-User-UUID`.
272+
Compass has a concept of User. In the current version, all APIs in Compass require an identity header in the request. The header key is configurable but the default name is `Compass-User-UUID`.
273273

274-
Compass APIs also expect an additional optional e-mail header. This is also configurable and the default name is `Compass-User-Email`. The purpose of having this optional e-mail header is described in the [User](./concepts/user.md) section.
274+
Compass APIs also expect an additional optional e-mail header. This is also configurable and the default name is `Compass-User-Email`. The purpose of having this optional e-mail header is described in the API reference.
275275

276276
If everything goes ok, you should see something like this:
277277

docs/docs/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ You can use the Compass command line interface to issue commands and to perform
4444
### HTTPS API
4545

4646
You can get hands on asset searching, listing, tagging, starring and much more by using the Compass HTTPS API, which lets you issue HTTPS requests directly to the service. When you use the HTTPS API, you must include the user information from the configurable identity uuid in the request header.
47-
For more information, see the [User Management](./concepts/user.md) and [API reference](./reference/api.md) pages.
47+
For more information, see the [API reference](./reference/api.md) page.
4848

4949
## Where to go from here
5050

docs/docs/reference/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,15 @@ Compass's required variables to start using it.
6060
### `IDENTITY_UUID_HEADER`
6161
* Example value: `Compass-User-UUID`
6262
* Type: `required`
63-
* Header key to accept Compass User UUID. See [User](../concepts/user.md) for more information about the usage.
63+
* Header key to accept Compass User UUID. See the API reference for more information.
6464
### `IDENTITY_EMAIL_HEADER`
6565
* Example value: `Compass-User-Email`
6666
* Type: `optional`
67-
* Header key to accept Compass User Email. See [User](../concepts/user.md) for more information about the usage.
67+
* Header key to accept Compass User Email. See the API reference for more information.
6868
### `IDENTITY_PROVIDER_DEFAULT_NAME`
6969
* Example value: `shield`
7070
* Type: `optional`
71-
* Default value of user provider. See [User](../concepts/user.md) for more information about the usage.
71+
* Default value of user provider. See the API reference for more information.
7272

7373
## Telemetry
7474

0 commit comments

Comments
 (0)