-
Notifications
You must be signed in to change notification settings - Fork 0
Refresh docs and add agent guide #5
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.
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
Open
mrhegemon
wants to merge
2
commits into
main
Choose a base branch
from
codex/docs-refresh
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Codex Agent Guide | ||
|
|
||
| ## Repo Summary | ||
| - Offline emergency knowledge assistant built in C++ with llama.cpp. | ||
| - Docker Compose runs `tika`, `jic` (server), and `ingestion`. | ||
| - Documents live under `public/sources` and are ingested into a vector index. | ||
|
|
||
| ## Key Paths | ||
| - `docker-compose.yml`: primary model configuration and service wiring. | ||
| - `src/`: C++ server and ingestion pipeline. | ||
| - `public/sources/`: PDFs and other content to ingest. | ||
| - `helper-scripts/`: scripts for model fetching and basic testing. | ||
|
|
||
| ## Local Setup | ||
| 1. Install Docker + Docker Compose. | ||
| 2. Download GGUF files into `./gguf_models/` (see `helper-scripts/fetch-models.sh`). | ||
| 3. Run: `docker compose up --build`. | ||
|
|
||
| ## Tests (Local) | ||
| - Config sanity: `./helper-scripts/test-config.sh` | ||
| - Server smoke test (server must be running): `./helper-scripts/test-server.sh` | ||
|
|
||
| ## Remote / CI Guidance | ||
| - Minimal CI should run `./helper-scripts/test-config.sh`. | ||
| - Optional CI step (if services can be started): `docker compose up -d` then `./helper-scripts/test-server.sh`, then `docker compose down`. | ||
|
|
||
| ## Data Notes | ||
| - Keep licensing and provenance clear for all added sources. | ||
| - Prefer public-domain or explicitly redistributable materials. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| # 300 Food | ||
| ### This is a starting MVP dataset. LOOKING FOR CONTRIBUTION Please suggest files as issues! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,17 @@ | ||
| # DOWNLOADS | ||
| # DOWNLOADS | ||
|
|
||
| WIP: [AUTO DOWNLOAD SCRIPTS](https://github.com/companionintelligence/JustInCase/blob/main/helper-scripts/fetch-source-data.sh) | ||
|
|
||
|
|
||
| TODO: MIRROR DOWNLOADS IN TORRENTS | ||
|
|
||
| - [RECCOMENDED - LibreText Textbooks](https://drive.google.com/drive/folders/1cQRIxQwKx4a80hRzMF5DVE1lmovjHwCF?usp=sharing) | ||
| - [RECCOMENDED - OpenStax Textbooks](https://drive.google.com/drive/folders/1uxihkCdCbSavluFWFQYVtXM_wp8k2UtY?usp=sharing) | ||
| - [RECCOMENDED - Survival Data Corpus](https://github.com/PR0M3TH3AN/Survival-Data) | ||
| - [RECCOMENDED - Standard ebooks](https://standardebooks.org/bulk-downloads) | ||
| - [RECCOMENDED - Gutenberg file URLs for ebook id](https://www.gutenberg.org/ebooks/) | ||
| - [Archive.org](Archive.org) | ||
| - [RECOMMENDED - LibreText Textbooks](https://drive.google.com/drive/folders/1cQRIxQwKx4a80hRzMF5DVE1lmovjHwCF?usp=sharing) | ||
| - [RECOMMENDED - OpenStax Textbooks](https://drive.google.com/drive/folders/1uxihkCdCbSavluFWFQYVtXM_wp8k2UtY?usp=sharing) | ||
| - [RECOMMENDED - Survival Data Corpus](https://github.com/PR0M3TH3AN/Survival-Data) | ||
| - [RECOMMENDED - Standard Ebooks](https://standardebooks.org/bulk-downloads) | ||
| - [RECOMMENDED - Gutenberg file URLs for ebook id](https://www.gutenberg.org/ebooks/) | ||
| - [Archive.org](https://archive.org) | ||
| - [librivox # find librivox/IA zip](https://librivox.org/) | ||
| - [standardebooks bulk](https://standardebooks.org/bulk-downloads) | ||
|
|
||
| Note: Verify licenses before mirroring or redistributing any content. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documented default for
QWEN_GGUF_REPOnow saysQwen/Qwen2.5-VL-7B-Instruct-GGUF, but the actual download logic defaults toggml-org/Qwen2.5-VL-7B-Instruct-GGUFinhelper-scripts/fetch-models.sh(line 13). This mismatch can cause users who rely on this doc to set an incorrect repo override and then fail or fetch unexpected artifacts when running the model download flow.Useful? React with 👍 / 👎.