docs: sync llms.txt with multi-generation engine changes - #107
Open
LeonSGP43 wants to merge 1 commit into
Open
Conversation
cd2f976 introduced Needle 2/3 engine generations (--generation flag on fetch/download, NEEDLE2/NEEDLE3_LIB_PATH overrides) and a strict mode for extract(), and updated doc/apis.md accordingly, but llms.txt was not fully synced. This PR closes the four gaps: - CLI summary 'fetch': add --generation 2|3 flag (default: 2) - CLI summary 'download': add --generation 2|3 flag for platform builds - CLI summary 'fetch' air-gapped hint: point at NEEDLE2_LIB_PATH / NEEDLE3_LIB_PATH (legacy NEEDLE_LIB_PATH is a Needle 2 alias, deliberately ignored for Needle 3), matching doc/apis.md - Core API 'extract': add strict=True parameter and its semantics (temporal contradictions and engine-reported fabricated/negated values raise ExtractionValidationError) No behavioral changes; documentation-only. Signed-off-by: LeonSGP43 <cine.dreamer.one@gmail.com>
LeonSGP43
force-pushed
the
docs-llms-generation-sync
branch
from
September 4, 2026 02:48
33a18cb to
d7225bf
Compare
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.
What
cd2f976introduced Needle 2/3 engine generations (--generationflag onfetch/download,NEEDLE2_LIB_PATH/NEEDLE3_LIB_PATHoverrides) and astrictmode forextract(), and updateddoc/apis.mdaccordingly — butllms.txtwas not fully synced. This PR closes the four gaps, keepingllms.txtconsistent with the code anddoc/apis.md:llms.txtlocationneedle fetchneedle download <platform>fetchair-gapped hintNEEDLE_LIB_PATHNEEDLE2_LIB_PATH/NEEDLE3_LIB_PATH(legacy var is a Needle 2 alias, deliberately ignored for Needle 3), matchingdoc/apis.mdneedle.extract(...)strict=Trueparameter missingExtractionValidationError)Verification
Each edit is anchored in the code or
doc/apis.md:needle/cli.py:--generationargument (choices=[2, 3],default=2) exists on both thefetchand platform-branchdownloadpaths.doc/apis.md: air-gap section documentsNEEDLE2_LIB_PATH/NEEDLE3_LIB_PATHand the legacy-alias behavior; the API table already listsstrict=Trueforextract.needle/__init__.py:extract(..., strict: bool = True)with the docstring quoted for the semantics line.Scope
Documentation-only,
llms.txtonly — no behavioral changes, no other files touched.Signed-off-by: Leon Gong leongong43@gmail.com