Skip to content

docs: sync llms.txt with multi-generation engine changes - #107

Open
LeonSGP43 wants to merge 1 commit into
cactus-compute:mainfrom
LeonSGP43:docs-llms-generation-sync
Open

docs: sync llms.txt with multi-generation engine changes#107
LeonSGP43 wants to merge 1 commit into
cactus-compute:mainfrom
LeonSGP43:docs-llms-generation-sync

Conversation

@LeonSGP43

Copy link
Copy Markdown
Contributor

What

cd2f976 introduced Needle 2/3 engine generations (--generation flag on fetch/download, NEEDLE2_LIB_PATH/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, keeping llms.txt consistent with the code and doc/apis.md:

# llms.txt location Gap Fix
1 CLI summary — needle fetch `--generation 2 3` flag missing
2 CLI summary — needle download <platform> `--generation 2 3` flag missing
3 CLI summary — fetch air-gapped hint Only mentions legacy NEEDLE_LIB_PATH Now points at NEEDLE2_LIB_PATH/NEEDLE3_LIB_PATH (legacy var is a Needle 2 alias, deliberately ignored for Needle 3), matching doc/apis.md
4 Core API — needle.extract(...) strict=True parameter missing Added to signature plus one-line semantics from the docstring (temporal contradictions / engine-reported fabricated or negated values raise ExtractionValidationError)

Verification

Each edit is anchored in the code or doc/apis.md:

  • needle/cli.py: --generation argument (choices=[2, 3], default=2) exists on both the fetch and platform-branch download paths.
  • doc/apis.md: air-gap section documents NEEDLE2_LIB_PATH/NEEDLE3_LIB_PATH and the legacy-alias behavior; the API table already lists strict=True for extract.
  • needle/__init__.py: extract(..., strict: bool = True) with the docstring quoted for the semantics line.

Scope

Documentation-only, llms.txt only — no behavioral changes, no other files touched.

Signed-off-by: Leon Gong leongong43@gmail.com

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>
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