docs(readme): Litmus first-run callout and libreoffice typo - #2435
Closed
kheiss-uwzoo wants to merge 2 commits into
Closed
docs(readme): Litmus first-run callout and libreoffice typo#2435kheiss-uwzoo wants to merge 2 commits into
kheiss-uwzoo wants to merge 2 commits into
Conversation
Address Litmus Docs Readiness P1/P2 findings without changing CLI or library behavior: promote the corpus-size warning, point first ingest at data/, and correct libeoffice.
Replace absolute single-PDF failure wording with skip/clamp guidance so the Litmus first-run README matches current LanceDB indexing on main.
kheiss-uwzoo
force-pushed
the
docs/litmus-readme-first-run
branch
from
August 7, 2026 18:42
b291db8 to
3ecf5d7
Compare
4 tasks
Collaborator
Author
|
Superseded by #2430 — the Litmus README first-run guidance (LanceDB corpus-size / IVF callout, directory first-run, and the libeoffice -> libreoffice typo fix) is folded into the combined 26.08 RC readiness PR. Closing to consolidate the 26.08 docs changes into one review. |
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
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.
Summary
::vdron NRL: promote the LanceDB corpus-size warning before first ingest examples, point CLI first-run at../data, and omit.vdb_upload()from the single-PDF inspect example so the happy path does not surprise new users at indexing.libeoffice→libreofficein the Office prerequisite prose (command was already correct).main: very small corpora may skip the vector index or use fewer IVF partitions than the default (not an absolute hard-fail).nemo_retriever/src/**, CLI, or default behavior changes.Out of scope (intentionally)
Test plan
Run the pipeline: corpus callout appears before first examples../dataand Python single-PDF example has no.vdb_upload()libreofficespelling in Office prerequisite sentence