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
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ passage may leave the machine, connect a local CLI or MCP consumer, or add Ragmi
answer generation from a verified local model.

[Website](https://ragmir.com) · [npm](https://www.npmjs.com/package/@jcode.labs/ragmir) ·
[Documentation](https://github.com/jcode-works/jcode-ragmir/wiki) ·
[CLI reference](./docs/cli-reference.md) · [Examples](#runnable-examples)

## Your first cited search
Expand Down Expand Up @@ -224,8 +225,13 @@ outside Git or under ignored local state.

## Documentation

Browse the [project wiki](https://github.com/jcode-works/jcode-ragmir/wiki) to navigate the complete
documentation. The versioned files below remain canonical for releases, npm packages, Context7,
and pull-request review.

| Guide | Read it when you need |
| --- | --- |
| [Project wiki](https://github.com/jcode-works/jcode-ragmir/wiki) | Browse every guide from one documentation index |
| [CLI reference](./docs/cli-reference.md) | Commands, options, and JSON output |
| [API reference](./docs/api-reference.md) | TypeScript exports and result shapes |
| [Release history](https://github.com/jcode-works/jcode-ragmir/releases) | Generated notes, compatibility changes, and verification artifacts |
Expand Down
1 change: 1 addition & 0 deletions llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ store.

## Documentation

- [Documentation wiki](https://github.com/jcode-works/jcode-ragmir/wiki)
- [README](https://raw.githubusercontent.com/jcode-works/jcode-ragmir/main/README.md)
- [CLI reference](https://raw.githubusercontent.com/jcode-works/jcode-ragmir/main/docs/cli-reference.md)
- [API reference](https://raw.githubusercontent.com/jcode-works/jcode-ragmir/main/docs/api-reference.md)
Expand Down
2 changes: 2 additions & 0 deletions packages/ragmir-chat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Ragmir does not require this package or any model to retrieve evidence. Use Core
AI or automation, and add Chat only when answer generation also needs to stay on the workstation.

[Ragmir overview](https://github.com/jcode-works/jcode-ragmir#readme) ·
[Documentation](https://github.com/jcode-works/jcode-ragmir/wiki) ·
[Offline chat guide](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/offline-chat-preload.md) ·
[Core package](https://www.npmjs.com/package/@jcode.labs/ragmir)

Expand Down Expand Up @@ -142,6 +143,7 @@ is the explicit setup step on a connected machine.

## Further reading

- [Project documentation](https://github.com/jcode-works/jcode-ragmir/wiki)
- [Offline chat preparation](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/offline-chat-preload.md)
- [Ragmir configuration](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/configuration.md)
- [Troubleshooting](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/troubleshooting.md)
Expand Down
2 changes: 2 additions & 0 deletions packages/ragmir-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ automation you already use, or keep the consumer local when no retrieved passage
workstation.

[Project overview](https://github.com/jcode-works/jcode-ragmir#readme) ·
[Documentation](https://github.com/jcode-works/jcode-ragmir/wiki) ·
[CLI reference](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/cli-reference.md) ·
[API reference](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/api-reference.md)

Expand Down Expand Up @@ -185,6 +186,7 @@ before indexing sensitive material.

## Documentation

- [Project documentation](https://github.com/jcode-works/jcode-ragmir/wiki)
- [CLI reference](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/cli-reference.md)
- [TypeScript API reference](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/api-reference.md)
- [Configuration](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/configuration.md)
Expand Down
3 changes: 2 additions & 1 deletion packages/ragmir-landing/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Ragmir Landing

The static, telemetry-free website for [Ragmir](https://ragmir.com).
The static, telemetry-free website for [Ragmir](https://ragmir.com). Public guides are available in
the [project documentation](https://github.com/jcode-works/jcode-ragmir/wiki).

This private workspace package presents the open-source CLI, TypeScript API, MCP integration, local
chat, local audio, and privacy boundaries. It does not host document storage, user accounts, a
Expand Down
4 changes: 2 additions & 2 deletions packages/ragmir-landing/public/ai.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ Do not describe Ragmir as Gemma-based. Do not claim hosted storage, cloud sync,
support, automatic compliance, legal authority, or a replacement for dedicated code search or
agent memory.

See `/llms.txt` and the canonical repository README for current setup, package, format, and privacy
details.
See the [documentation wiki](https://github.com/jcode-works/jcode-ragmir/wiki), `/llms.txt`, and the
canonical repository README for current setup, package, format, and privacy details.
1 change: 1 addition & 0 deletions packages/ragmir-landing/public/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ pnpm exec rgr search "Which decision changed the rollout?"

## Canonical documentation

- [Documentation wiki](https://github.com/jcode-works/jcode-ragmir/wiki)
- [README](https://github.com/jcode-works/jcode-ragmir#readme)
- [CLI reference](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/cli-reference.md)
- [API reference](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/api-reference.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const version = import.meta.env.PUBLIC_RAGMIR_VERSION
const footerLinks = [
{ href: "https://github.com/jcode-works/jcode-ragmir", label: t("nav_github") },
{ href: "https://www.npmjs.com/package/@jcode.labs/ragmir", label: t("footer_link_npm") },
{ href: "https://github.com/jcode-works/jcode-ragmir#readme", label: t("footer_link_docs") },
{ href: "https://github.com/jcode-works/jcode-ragmir/wiki", label: t("footer_link_docs") },
{ href: "https://github.com/jcode-works/jcode-ragmir/releases/latest", label: t("footer_link_releases") },
{ href: "https://github.com/jcode-works/jcode-ragmir/blob/main/CHANGELOG.md", label: t("footer_link_changelog") },
{ href: "https://github.com/jcode-works/jcode-ragmir/blob/main/docs/api-reference.md", label: t("footer_link_api") },
Expand Down
2 changes: 2 additions & 0 deletions packages/ragmir-tts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ default Transformers.js path produces WAV audio locally after the model is prepa
Edge mode produces online neural-voice MP3 when sending narration text to that service is acceptable.

[Ragmir overview](https://github.com/jcode-works/jcode-ragmir#readme) ·
[Documentation](https://github.com/jcode-works/jcode-ragmir/wiki) ·
[Offline TTS guide](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/offline-tts-preload.md) ·
[Core package](https://www.npmjs.com/package/@jcode.labs/ragmir)

Expand Down Expand Up @@ -120,6 +121,7 @@ local `edge-tts` executable, and removes temporary files after rendering.

## Further reading

- [Project documentation](https://github.com/jcode-works/jcode-ragmir/wiki)
- [Offline TTS preparation](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/offline-tts-preload.md)
- [Ragmir configuration](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/configuration.md)
- [Troubleshooting](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/troubleshooting.md)
Expand Down