Skip to content

docs: promote the acknowledgements refresh and the reindex-warning removal - #257

Merged
dvcdsys merged 3 commits into
mainfrom
develop
Aug 16, 2026
Merged

docs: promote the acknowledgements refresh and the reindex-warning removal#257
dvcdsys merged 3 commits into
mainfrom
develop

Conversation

@dvcdsys

@dvcdsys dvcdsys commented Aug 16, 2026

Copy link
Copy Markdown
Owner

Promotion of #256 to main.

Nothing under site/ changed, so this does not alter the deployed site. What it does change is what people read first: the README is served from main on the repository landing page, and the install one-liner fetches install-server.sh from main.

What goes live

Acknowledgements, matched to what actually ships. lucide was credited for the dashboard's icons and is not a dependency at all — the cream & ink rewrite replaced icon fonts with hand-drawn marks. gronx, go-gitignore, validator and React Router were shipping uncredited. chromem-go and gotreesitter move into a group that says they are no longer in the running system, rather than sitting in a list a reader takes for the current stack — kept, not deleted, because the early versions worked because of them.

Why the vectors moved. The architecture section showed the SQLite store but never said why it replaced chromem-go. It now carries the measured trade: 2.2 GB idle and a 47-second cold boot on a 312k-document index, against tens of megabytes and about a millisecond, at roughly 4× search latency.

doc/LANGUAGES.md still told readers the chunker runs through gotreesitter and tabulated Go factory names that no longer exist. Grammars are WASM on wazero; the stale column is dropped, all 31 language rows intact.

Ten comments across the server described the removed engine as the current one — dense search as "chromem cosine", the router's "chromem-go backed vector store", rounding "chromem already applies". One was a correction rather than a rename: the vector store's package comment claimed 3× chromem's search latency where the measured table says 4×.

The blanket reindex warning is gone from the README and from TEAM_DEPLOYMENT.md. An upgrade keeps working against the existing index, and 0.13 imports the vectors itself without re-embedding. The narrow cases that do need a reindex stay documented in UPDATES.md §3, whose dangling pointer to a README section that lives in DASHBOARD.md is fixed too.

🤖 Generated with Claude Code

dvcdsys and others added 3 commits August 16, 2026 13:20
The Acknowledgements list had drifted from `go.mod` and `package.json` in
both directions.

- **lucide** is credited for the dashboard's icons and is not a
  dependency at all — the cream & ink rewrite replaced icon fonts with
  hand-drawn marks, and the one place lucide is still named in the source
  is a comment explaining why the brand mark is *not* one.
- **gronx** (the crontab expressions behind scheduled maintenance),
  **go-gitignore** (`.cixignore`/`.gitignore` matching), **validator**
  and **React Router** were all shipping uncredited.
- **chromem-go** and **gotreesitter** are no longer part of the running
  system — one survives as an importer for pre-0.13 indexes, the other is
  gone entirely — so they move to their own group that says so, rather
  than sitting in a list a reader takes for the current stack. They are
  kept, not deleted: the early versions worked because of them.

While here, `doc/LANGUAGES.md` still told readers the chunker runs
through gotreesitter and tabulated Go factory names (`PythonLanguage`)
that no longer exist. Grammars are WASM on wazero now; the column is
dropped rather than corrected, since the language ID is what a reader
actually passes to `CIX_LANGUAGES`. The language count is 31 in three
places and was "30+" in two of them.

Also retires ten comments across the server that still describe the
removed engine as the current one — dense search as "chromem cosine",
the router's "chromem-go backed vector store", rounding "chromem already
applies" (the vector store applies it), and the claim that int8 is out of
scope because "chromem-go has no hamming search". The vector store's own
package comment claimed 3x chromem's search latency where the measured
table in doc/VECTORSTORE.md says 4x; it now cites the table.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The README opened with a warning that an upgrade can change how code is
embedded "until the parsing/chunking/embedding pipeline stabilizes", and
`TEAM_DEPLOYMENT.md` repeated it to operators. It is no longer what
happens: an upgrade keeps working against the index you already have, and
the one change big enough to invalidate it — 0.13 moving the vectors into
SQLite — imports them on first boot without re-embedding anything.

The cases that genuinely need a reindex are narrow and already documented
where someone hits them: the embedding model changing (the dashboard
flags those projects itself) and a release that backfills new chunk-level
data. `UPDATES.md` §3 lists both, so the operator note now points there
instead of asking for a reindex nobody needs.

Also fixes that section's dangling pointer — it sent readers to a
"Drift indicator" section of the README that lives in DASHBOARD.md.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
docs: credit the stack we actually ship, and finish the chromem sweep
@dvcdsys
dvcdsys merged commit 0dc3f85 into main Aug 16, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant