Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
686 changes: 0 additions & 686 deletions 2026-01-07_Epic3_Recommender_Agent_Plan_DRAFT.md

This file was deleted.

193 changes: 0 additions & 193 deletions BRANCH_SYNC_STRATEGY.md

This file was deleted.

22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
<img src="https://raw.githubusercontent.com/tabiya-tech/docs/refs/heads/main/.gitbook/assets/compass_logo_web_dark.png#gh-light-mode-only" alt="logo" width=300/>
</h1>

**Compass** is an AI chatbot designed to assist job-seekers in exploring and discovering their skills.
**Compass Connect** is an AI chatbot designed to assist job-seekers in exploring and discovering their skills.

Compass has two objectives:
Compass Connect has two objectives:
- Populate a digital skill wallet that captures the experience of job-seekers, including the
skills inherent in their formal and informal work.
- By doing so, guide job-seekers in exploring and discovering
Expand All @@ -28,33 +28,33 @@ their skills and interests based on their lived experiences.


## Architecture Overview
The images below show a high level overview of the solution architecture of Compass.
The images below show a high level overview of the solution architecture of Compass Connect.

![Compass Architecture Overview](https://lucid.app/publicSegments/view/a1c21a2d-162b-4eae-b70a-f57b44181aa1/image.png)
![Compass Connect Architecture Overview](https://lucid.app/publicSegments/view/a1c21a2d-162b-4eae-b70a-f57b44181aa1/image.png)

![Compass Cloud Architecture](https://lucid.app/publicSegments/view/fb45c622-0edb-4257-84a3-6fc4996692f3/image.png)
![Compass Connect Cloud Architecture](https://lucid.app/publicSegments/view/fb45c622-0edb-4257-84a3-6fc4996692f3/image.png)

![Compass Backend Architecture](https://lucid.app/publicSegments/view/3e5323ab-786b-4d46-bb73-dd716cdd9ee0/image.png)
![Compass Connect Backend Architecture](https://lucid.app/publicSegments/view/3e5323ab-786b-4d46-bb73-dd716cdd9ee0/image.png)

![Compass AI Architecture](https://lucid.app/publicSegments/view/db45dc1c-b89e-4ae4-bd32-347092693844/image.png)
![Compass Connect AI Architecture](https://lucid.app/publicSegments/view/db45dc1c-b89e-4ae4-bd32-347092693844/image.png)

## Why Contribute?

- **Make an Impact:** Your contributions will directly improve the user experience and functionality of Compass, helping job-seekers explore and discover their skills more effectively.
- **Help Achieve Our Goals:** By contributing, you are supporting Compass’s mission to populate digital skill wallets and guide job-seekers in understanding their skills and interests based on their lived experiences.
- **Make an Impact:** Your contributions will directly improve the user experience and functionality of Compass Connect, helping job-seekers explore and discover their skills more effectively.
- **Help Achieve Our Goals:** By contributing, you are supporting Compass Connect’s mission to populate digital skill wallets and guide job-seekers in understanding their skills and interests based on their lived experiences.

## Ways to Contribute

1. **Reporting Issues:** If you encounter bugs or have suggestions, open an issue on GitHub. Your feedback is valuable.
2. **Code Contributions:** Help enhance the codebase by submitting pull requests.
3. **Write or Improve Tests:** We aim for 100% code coverage. You can help achieve this goal by writing or improving tests.
4. **Documentation:** Improve project documentation by submitting pull requests. Clear documentation is crucial for new contributors.
5. **Add a New Language**: Help make Compass accessible to more users by adding support for a new language. Follow the guidelines in [add-a-new-language.md](./add-a-new-language.md).
5. **Add a New Language**: Help make Compass Connect accessible to more users by adding support for a new language. Follow the guidelines in [add-a-new-language.md](./add-a-new-language.md).
6. **Support:** Give the project a star on GitHub—your support encourages us to keep improving!

## Contribution Guidelines

🎉 Thank you for considering contributing to Tabiya Compass! 🎉
🎉 Thank you for considering contributing to Tabiya Compass Connect! 🎉

### Code Formatting

Expand Down
4 changes: 2 additions & 2 deletions add-a-new-language.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Compass Language Guide
# Compass Connect Language Guide

This guide is divided into two main parts:

Expand Down Expand Up @@ -134,7 +134,7 @@ Supported languages are enabled via environment variables on both backend and fr

## Switching or Using Supported Languages

This section explains how to enable or switch between languages that are already supported in Compass.
This section explains how to enable or switch between languages that are already supported in Compass Connect.

### Overview

Expand Down
4 changes: 2 additions & 2 deletions admin-frontend/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Compass Admin Frontend
# Compass Connect Admin Frontend

The Compass Admin Portal is a web application for managing and configuring the Compass platform. It provides administrators with tools to manage users, view analytics, and configure system settings.
The Compass Connect Admin Portal is a web application for managing and configuring the Compass Connect platform. It provides administrators with tools to manage users, view analytics, and configure system settings.

## Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion admin-registration.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The dashboard self-creation flow requires an existing super admin to approve / p
```bash
cd backend
poetry run python scripts/admin/create_admin_user.py \
--name "Compass Super Admin" \
--name "Compass Connect Super Admin" \
--email "superadmin@<env>.example.com" \
--role super_admin \
--tenant-id "$ADMIN_FIREBASE_TENANT_ID" \
Expand Down
2 changes: 1 addition & 1 deletion backend/EVALUATION_TESTS_README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Evaluation Tests

Tests used for evaluating the correctness and performance of the
compass app and individual agents.
compass-connect app and individual agents.

## Marking a test as `evaluation_test`

Expand Down
8 changes: 4 additions & 4 deletions backend/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Compass Backend
# Compass Connect Backend

FastAPI application serving the Compass career guidance API with AI-powered conversational agents.
FastAPI application serving the Compass Connect career guidance API with AI-powered conversational agents.

## Prerequisites

Expand Down Expand Up @@ -53,7 +53,7 @@ poetry run python app/server.py

## Running the code locally

The backend is a FastAPI app that serves the Compass API.
The backend is a FastAPI app that serves the Compass Connect API.

When running the code locally, the backend will use the credentials and the project set in the Google Cloud SDK.

Expand Down Expand Up @@ -149,7 +149,7 @@ The backend uses the following environment variables:
- `GOOGLE_APPLICATION_CREDENTIALS`: The path to the service account key file.
- `TAXONOMY_MONGODB_URI`: The URI of the MongoDB Atlas instance where the ESCO taxonomy data is stored.
- `TAXONOMY_DATABASE_NAME`: The name of mongo db database where the ESCO taxonomy data with the embeddings is stored.
- `TAXONOMY_MODEL_ID`: The model ID of the ESCO model in the compass taxonomy database.
- `TAXONOMY_MODEL_ID`: The model ID of the ESCO model in the compass-connect taxonomy database.
- `APPLICATION_MONGODB_URI`: The URI of the MongoDB Atlas instance for the application database.
- `APPLICATION_DATABASE_NAME`: The name of mongo db database used by the application to store data.
- `USERDATA_MONGODB_URI`: The URI of the MongoDB instance for the user data database.
Expand Down
2 changes: 1 addition & 1 deletion backend/app/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Agent-based design

The Compass conversational agent under the hood is designed as a set of agents interacting together. Agents may have
The Compass Connect conversational agent under the hood is designed as a set of agents interacting together. Agents may have
"sub-agents" if they are complex enough.

Agents are coordinated by the **AgentDirector**.
Expand Down
12 changes: 6 additions & 6 deletions backend/app/agent/preference_elicitation_agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Epic 2 - Deliverable D1, D2, D3**

This package contains the implementation of the Preference Elicitation Agent for the Compass career guidance system.
This package contains the implementation of the Preference Elicitation Agent for the Compass Connect career guidance system.

## Overview

Expand Down Expand Up @@ -146,7 +146,7 @@ COMPLETE

### Vignettes Configuration

Vignettes are stored in `/compass/backend/app/config/vignettes.json`:
Vignettes are stored in `/compass-connect/backend/app/config/vignettes.json`:

```json
[
Expand Down Expand Up @@ -176,7 +176,7 @@ Vignettes are stored in `/compass/backend/app/config/vignettes.json`:

### Vignette Templates Configuration

Vignette templates are stored in `/compass/backend/app/config/vignette_templates.json`:
Vignette templates are stored in `/compass-connect/backend/app/config/vignette_templates.json`:

```json
[
Expand Down Expand Up @@ -281,7 +281,7 @@ print(output.message_for_user)
Run tests:

```bash
cd compass/backend
cd compass-connect/backend
poetry run pytest app/agent/preference_elicitation_agent/test_preference_elicitation_agent.py -v
```

Expand Down Expand Up @@ -356,7 +356,7 @@ state = PreferenceElicitationAgentState(
)
```

**Full Compass Flow**:
**Full Compass Connect Flow**:
```python
# Copy from prior agent for consistency
explored = app_state.explore_experiences_director_state.explored_experiences
Expand Down Expand Up @@ -436,7 +436,7 @@ class PreferenceElicitationAgentState:
initial_experiences_snapshot: Optional[list[ExperienceEntity]] = None
"""
Immutable snapshot of experiences at agent start.
Sources: CV upload, prior Compass session, or DB6
Sources: CV upload, prior Compass Connect session, or DB6
"""
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

```bash
# Navigate to backend directory
cd compass/backend
cd compass-connect/backend

# Install dependencies
poetry install --sync
Expand Down Expand Up @@ -1627,7 +1627,7 @@ export ADAPTIVE_FIM_THRESHOLD=25.0

**Solution**:
```bash
cd compass/backend
cd compass-connect/backend
poetry install --sync
```

Expand Down
Loading
Loading