Skip to content

Adding Getting Started Docs - #324

Open
orlax wants to merge 1 commit into
mainfrom
docs/getting-started
Open

orlax wants to merge 1 commit into
mainfrom
docs/getting-started

Conversation

@orlax

@orlax orlax commented Oct 9, 2026

Copy link
Copy Markdown
Collaborator

docs(getting-started): add a guide to run Compass Connect locally on the Atlas free tier

  • guide: from a fresh clone to a first conversation, using local MongoDB for app data and Atlas M0 (free tier) for the embeddings.

  • setup_taxonomy.py: one command downloads the taxonomy zip from taxonomy.tabiya.tech, maps it, embeds it with Vertex AI and uploads it to Atlas automatically.

  • taxnomy is embedded in partial mode (default) keeps all occupations and the 5,500 most used skills so it fits the 512 MB of Atlas free tier, " --mode full" can be used to embed the full taxonomy.

  • smoke test and search check scripts allow to confirm the connected google account works correctly.

docs(getting-started): add a guide to run Compass Connect locally on the Atlas free tier

- guide: from a fresh clone to a first conversation, using local MongoDB for
  app data and Atlas M0 (free tier) for the embeddings.

- setup_taxonomy.py: one command downloads the taxonomy zip from
  taxonomy.tabiya.tech, maps it, embeds it with Vertex AI and uploads it to
  Atlas automatically.

- taxnomy is embedded in partial mode (default) keeps all occupations and the 5,500 most used skills  so it fits the 512 MB of Atlas free tier, " --mode full" can be used to embed the full taxonomy.

- smoke test and search check scripts allow to confirm the connected google account works correctly.
@orlax orlax added the documentation Improvements or additions to documentation label Oct 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant