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
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ actually used to win, and lets that knowledge compound across runs.
half-life curve, and non-trivial sessions auto-harvest their lessons.

Full mechanics, scoring, citations, decay, conflict detection, and the daemon
are in **[How Kimetsu Works](docs/HOW-KIMETSU-WORKS.md)**.
are in **[How Kimetsu Works](https://rodcor.github.io/kimetsu/docs/how-kimetsu-works)**.

---

Expand All @@ -95,7 +95,7 @@ real exported memories. The latency-optimized default (ms-marco-tinybert-l-2-v2)
lands recall@4 0.949, MRR 0.914 at ~138 ms; the quality-best rerankers reach
recall@4 0.975, MRR 0.933. Swap embedder and reranker with one config key each
and re-judge on your own corpus. Full grid in
**[How Kimetsu Works](docs/HOW-KIMETSU-WORKS.md)**.
**[How Kimetsu Works](https://rodcor.github.io/kimetsu/docs/how-kimetsu-works)**.

---

Expand All @@ -110,7 +110,7 @@ kimetsu doctor --selftest # records a memory and retrieves it
```

Other install paths (cargo, prebuilt archives) and host-wiring details are in
**[docs/INSTALL.md](docs/INSTALL.md)**.
**[the install guide](https://rodcor.github.io/kimetsu/docs/install)**.

---

Expand All @@ -131,8 +131,8 @@ Other install paths (cargo, prebuilt archives) and host-wiring details are in
| `kimetsu brain bench` | Benchmark retrieval on your own corpus |

The full command surface, configuration keys, and maintenance commands are in
**[How Kimetsu Works](docs/HOW-KIMETSU-WORKS.md)** and
**[docs/INSTALL.md](docs/INSTALL.md)**.
**[How Kimetsu Works](https://rodcor.github.io/kimetsu/docs/how-kimetsu-works)** and
**[the install guide](https://rodcor.github.io/kimetsu/docs/install)**.

---

Expand All @@ -150,7 +150,7 @@ kimetsu plugin install claude-code --remote https://kimetsu.example.com:8787

Bearer auth, per-repo brains, an optional shared org-brain, server-side repo
ingest, TLS, Prometheus metrics, and a server-side reranker. Full setup in
**[docs/REMOTE.md](docs/REMOTE.md)**.
**[the Kimetsu Remote guide](https://rodcor.github.io/kimetsu/docs/remote)**.

---

Expand All @@ -170,14 +170,14 @@ Built as a small Rust workspace. Lint and tests run clean on every change.

## Docs

- **[Install & host wiring](docs/INSTALL.md)**: every install path, host
- **[Install & host wiring](https://rodcor.github.io/kimetsu/docs/install)**: every install path, host
wiring, auto-harvest and distiller setup, maintenance commands.
- **[How Kimetsu Works](docs/HOW-KIMETSU-WORKS.md)**: the brain, the broker,
- **[How Kimetsu Works](https://rodcor.github.io/kimetsu/docs/how-kimetsu-works)**: the brain, the broker,
citations, decay, conflict detection, the MCP surface, retrieval models and
benchmarking, configuration, the bridge, and doctor.
- **[Local models](docs/LOCAL-MODELS.md)**: run fully local with Ollama.
- **[Kimetsu Remote](docs/REMOTE.md)**: server setup, org brain, TLS, clients.
- **[CHANGELOG](CHANGELOG.md)**: what shipped in each release.
- **[Local models](https://rodcor.github.io/kimetsu/docs/local-models)**: run fully local with Ollama.
- **[Kimetsu Remote](https://rodcor.github.io/kimetsu/docs/remote)**: server setup, org brain, TLS, clients.
- **[CHANGELOG](https://rodcor.github.io/kimetsu/docs/changelog)**: what shipped in each release.

---

Expand Down
11 changes: 11 additions & 0 deletions website/scripts/sync-docs.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,20 @@ const DOCS = [

const stripBom = (s) => s.replace(/^/, '');

const SITE = 'https://rodcor.github.io/kimetsu/docs/';

function transformLinks(s) {
return (
s
// README links to this very site -> internal slugs, so the generated
// intro page navigates in-site (SPA) instead of doing a full reload to
// its own absolute URLs. The README keeps the absolute URLs for GitHub.
.replaceAll(`${SITE}how-kimetsu-works`, 'how-kimetsu-works')
.replaceAll(`${SITE}install`, 'install')
.replaceAll(`${SITE}local-models`, 'local-models')
.replaceAll(`${SITE}remote`, 'remote')
.replaceAll(`${SITE}roi-methodology`, 'roi-methodology')
.replaceAll(`${SITE}changelog`, 'changelog')
// README images -> Docusaurus static assets (raw <img> tags need the baseUrl)
.replaceAll('docs/assets/kimetsu-logo.png', '/kimetsu/img/kimetsu-logo.png')
.replaceAll('docs/assets/demo.gif', '/kimetsu/img/demo.gif')
Expand Down
Loading