Skip to content

Commit 48447f6

Browse files
docs(readme): convert README.adoc -> Markdown (renders on Glama/profile/community-health) (#55)
README was AsciiDoc → renders as raw markup in Markdown consumers (Glama MCP directory, GitHub community-health, GitHub profile). pandoc asciidoc→GFM (badges → clickable), SPDX header kept, duplicate `.adoc` removed. Part of the estate README-format fix. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent ebae2e8 commit 48447f6

2 files changed

Lines changed: 124 additions & 101 deletions

File tree

README.adoc

Lines changed: 0 additions & 101 deletions
This file was deleted.

README.md

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
<!--
2+
SPDX-License-Identifier: CC-BY-SA-4.0
3+
SPDX-FileCopyrightText: 2025-2026 Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
4+
-->
5+
6+
[![OpenSSF Best Practices](https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=opensourcesecurity)](https://www.bestpractices.dev/en/projects/new?repo_url=https://github.com/hyperpolymath/git-reticulator)
7+
[![License: MPL-2.0](https://img.shields.io/badge/License-MPL--2.0-blue.svg)](https://github.com/hyperpolymath/palimpsest-license)
8+
[![CRG C](https://img.shields.io/badge/CRG-C-yellow?style=flat-square)](https://github.com/hyperpolymath/standards/tree/main/component-readiness-grades)
9+
10+
Semantic-lattice + embedding builder for git repositories — the
11+
**symbolic half of a neuro-symbolic retrieval stack**. It lifts a repo
12+
from raw commits/blobs to a typed, hierarchical, embeddable structure
13+
you can **zoom** into, so an LLM gets the minimal relevant context
14+
instead of the whole tree.
15+
16+
> [!IMPORTANT]
17+
> **Maturity: experimental / early skeleton.** The Rust host is ~237 LOC
18+
> of `println!` stubs; the lattice core lives in
19+
> `src/lattice/affine/*.affine` (AffineScript) which **cannot compile
20+
> yet** and, as written, calls Rust crates AffineScript cannot bind.
21+
> `git2`/`postgres`/embeddings are feature-gated **off**. There are **no
22+
> proofs** — the word "lattice" is not yet earned (it is currently a
23+
> typed digraph; see
24+
> <a href="PROOF-NEEDS.md" class="md">PROOF-NEEDS</a>). Read
25+
> `.machine_readable/6a2/STATE.a2ml` for the honest status before
26+
> relying on anything here.
27+
28+
# Why this exists
29+
30+
Existing git-analysis tools work at the raw commit/blob level.
31+
`git-reticulator` lifts the analysis to a **navigable semantic
32+
structure** with two faculties fused at every node: an **order
33+
position** (symbolic) and an **embedding** (neural). That fusion is the
34+
basis for:
35+
36+
- **Token-bounded retrieval**`zoom_to_node(node,` `level)` returns
37+
the minimal relevant sub-structure (Level-of-Detail) for an LLM
38+
prompt.
39+
40+
- **Refactoring-impact / blast-radius** — weighted reachability
41+
(pgRouting Dijkstra/A\*) over typed edges.
42+
43+
- **Authorship + time queries** — "who owns this concept", "when did it
44+
enter the codebase" (maps onto verisim’s provenance + temporal
45+
modalities).
46+
47+
# The neuro-symbolic picture (where this is headed)
48+
49+
[git-reticulator] [RAG] [verisim octad] [vcl-ut]
50+
symbolic lattice -> embeddings -> 8-modal substrate -> proof-carrying
51+
+ per-node vector similarity (graph=lattice, queries
52+
(LOD zoom) search vector=embeddings, (FRESHNESS,
53+
provenance=authorship) PROVENANCE…)
54+
55+
The payoff is **proof-carrying retrieval**: neural search **proposes**
56+
context; the symbolic lattice + verisim + vcl-ut **dispose**, so a
57+
retrieved snippet can carry a machine-checked certificate that it really
58+
exists at HEAD (FRESHNESS), was authored by X (PROVENANCE), and isn’t
59+
hallucinated (EXISTENCE). See `.machine_readable/6a2/NEUROSYM.a2ml` and
60+
`.machine_readable/6a2/PLAYBOOK.a2ml`.
61+
62+
# Quickstart
63+
64+
```bash
65+
just build # cargo build (default features; no git2/db/embeddings)
66+
67+
# CLI binary is `reticulate` (subcommands: build | query | api):
68+
./target/debug/reticulate build --repo /path/to/repo --db postgres://localhost/gr
69+
./target/debug/reticulate query --zoom auth --db postgres://localhost/gr
70+
./target/debug/reticulate --help
71+
```
72+
73+
> [!NOTE]
74+
> these run today but are **stubs**`build` prints and returns; it
75+
> does not yet read the repo or write the DB.
76+
77+
# Architecture
78+
79+
- `src/lib.rs`, `src/cli/main.rs`, `src/api/app.rs` — Rust host (CLI +
80+
REST shell).
81+
82+
- `src/lattice/affine/*.affine` — intended lattice core (AffineScript;
83+
aspirational).
84+
85+
- `benches/`, `tests/` — criterion + smoke/contract tests.
86+
87+
- `.machine_readable/6a2/` — canonical project state, ecosystem,
88+
neuro-symbolic design, playbooks.
89+
90+
# Status & honesty
91+
92+
- **Licence**: MPL-2.0.
93+
94+
- **Maturity**: research / skeleton. API not stable.
95+
96+
- **Formal status**: zero proofs; see
97+
<a href="PROOF-NEEDS.md" class="md">PROOF-NEEDS</a> for the
98+
obligations the "lattice" claim incurs.
99+
100+
- **Honest state**: `.machine_readable/6a2/STATE.a2ml`
101+
(IMPLEMENTED\|SKELETON\|ASPIRATIONAL legend).
102+
103+
# Contributing
104+
105+
See <a href="CONTRIBUTING.md" class="md">CONTRIBUTING</a>. Commits must
106+
be GPG-signed; conventional-commits required (CHANGELOG generated via
107+
`standards` `changelog-reusable.yml`).
108+
109+
# Companion repositories
110+
111+
- [`affinescript`](https://github.com/hyperpolymath/affinescript) — the
112+
intended core language (compiles to Wasm).
113+
114+
- [`verisimdb`](https://github.com/hyperpolymath/verisimdb) — the octad
115+
substrate this can feed.
116+
117+
- [`vcl-ut`](https://github.com/hyperpolymath/vcl-ut) — proof-carrying
118+
query layer over verisim.
119+
120+
- [`standards`](https://github.com/hyperpolymath/standards) — canonical
121+
estate standards.
122+
123+
- [`k9`](https://github.com/hyperpolymath/k9) — metadata-extraction
124+
tooling (`k9iser.toml` consumed here).

0 commit comments

Comments
 (0)