Skip to content

Chore/fix readme #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DivyenduDutta merged 4 commits into from
Jan 3, 2026
Merged

Chore/fix readme #7

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1223a95
[DOC] Add new section for indexing module
DivyenduDutta Jan 3, 2026
608f52f
[DOC] Show architecture diagram inline in README
DivyenduDutta Jan 3, 2026
75ce19b
[DOC] Minor changes to README
DivyenduDutta Jan 3, 2026
afe59f0
[DOC] Minor changes to README
DivyenduDutta Jan 3, 2026
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
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,13 @@ RAG is good because:

[Chunker Module](atlas/core/chunker/README.md)

#### Embedding and Indexing
#### Embedding

[Embedding Module](atlas/core/embedder/README.md)
[Embedder Module](atlas/core/embedder/README.md)

#### Indexing

[Indexer Module](atlas/core/indexer/README.md)

#### Obsidian

Expand Down Expand Up @@ -78,7 +82,9 @@ So it follows the scaling law that even a small LLM when trained on enough quali

## Architecture

High level [architecture diagram](Resources/Atlas_Architecture.png)
Architecture diagram:

![architecture diagram](Resources/Atlas_Architecture.png)

A sample of the `obsidian_index.json` is as below:

Expand Down