docs: add module-level documentation to embeddings.ts and timeline-db.ts#226
Open
TerminalGravity wants to merge 1 commit intomainfrom
Open
docs: add module-level documentation to embeddings.ts and timeline-db.ts#226TerminalGravity wants to merge 1 commit intomainfrom
TerminalGravity wants to merge 1 commit intomainfrom
Conversation
Added comprehensive inline documentation to the two core files powering semantic search: - embeddings.ts: module overview, provider descriptions, usage example - timeline-db.ts: architecture diagram showing ~/.preflight/ layout, key function descriptions, connection pooling notes, JSDoc on getEventsTable, insertEvents, and buildWhereFilter
TerminalGravity
commented
Mar 12, 2026
Collaborator
Author
TerminalGravity
left a comment
TerminalGravity
left a comment
There was a problem hiding this comment.
Good docs additions. The module-level comments in both files are accurate and will help contributors understand the architecture quickly. The getEventsTable and insertEvents JSDoc additions are useful too.
One note: the embeddings.ts header still only lists Local and OpenAI providers (lines 8-11) but doesn't mention Voyage, which was added in #222. If that merges first, this PR should be rebased to include it in the provider list.
LGTM otherwise.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Adds comprehensive inline documentation to the two core files powering semantic search:
No code changes — documentation only.