add per-stage references for skill#2034
Conversation
Greptile SummaryThis PR adds 16 new per-stage reference files under
|
| Filename | Overview |
|---|---|
| .claude/skills/nemo-retriever/SKILL.md | Expanded subcommand references index, organized into logical categories; old "will be added" placeholder removed now that all refs exist. |
| .claude/skills/nemo-retriever/references/ingest.md | Added actionable "no --overwrite" guidance; the --overwrite example points to vector-store which overwrites by default, making the flag redundant in the snippet. |
| .claude/skills/nemo-retriever/references/local.md | New per-stage local runner reference; failure mode for stage6 overwrite mentions "pass the stage-appropriate flag" without naming it. |
| .claude/skills/nemo-retriever/references/pipeline.md | Comprehensive pipeline reference with flag groups, stage ordering, and cross-references; correctly calls out --use-table-structure/--use-graphic-elements off-by-default footgun. |
| .claude/skills/nemo-retriever/references/eval.md | Thorough eval reference; correctly documents the --lancedb-table vs --table-name naming inconsistency between eval export and the rest of the CLI. |
| .claude/skills/nemo-retriever/references/pipeline-stages.md | Useful cross-reference map linking each internal stage to its tuning flags, benchmark subcommand, and standalone CLI; consistent with other reference files. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
SKILL[SKILL.md\nentry point]
subgraph E2E["End-to-end / search"]
ingest[ingest.md]
query[query.md]
pipeline[pipeline.md]
service[service.md]
local[local.md]
end
subgraph EXTRACT["Per-input-type extractors"]
pdf[pdf.md]
chart[chart.md]
audio[audio.md]
txt[txt.md]
html[html.md]
image[image.md]
end
subgraph STORE["Storage and evaluation"]
vs[vector-store.md]
recall[recall.md]
eval[eval.md]
benchmark[benchmark.md]
harness[harness.md]
compare[compare.md]
end
subgraph CROSS["Cross-cutting"]
stages[pipeline-stages.md]
end
SKILL --> E2E
SKILL --> EXTRACT
SKILL --> STORE
SKILL --> CROSS
pipeline -->|"wraps"| pdf
pipeline -->|"wraps"| chart
pipeline -->|"wraps"| audio
ingest -->|"defaults wrapper"| pipeline
local -->|"per-stage debug"| pdf
local -->|"per-stage debug"| chart
local -->|"per-stage debug"| vs
pdf -->|"primitives feed"| chart
vs -->|"feeds"| recall
vs -->|"feeds"| eval
harness -->|"orchestrates"| recall
harness -->|"orchestrates"| eval
harness -->|"orchestrates"| benchmark
compare -->|"diffs output of"| recall
compare -->|"diffs output of"| eval
stages -->|"maps stages to"| pipeline
stages -->|"maps stages to"| benchmark
Prompt To Fix All With AI
Fix the following 2 code review issues. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 2
.claude/skills/nemo-retriever/references/ingest.md:99-100
Since `--overwrite` is the default for `vector-store stage run`, explicitly passing it adds no effect and may suggest to readers that it's a non-default option. Dropping the flag makes the example cleaner and avoids a misleading implication.
```suggestion
use [[vector-store]] (`vector-store stage run`) on the
embeddings stage of the [[local]] flow.
```
### Issue 2 of 2
.claude/skills/nemo-retriever/references/local.md:79-81
The failure mode says "pass the stage-appropriate flag" but never names it, leaving Claude (and human readers) without actionable guidance. If stage6 exposes something like `--append` or `--overwrite`, naming it here prevents a fruitless `--help` hunt.
```suggestion
- **`stage6` overwrites a table I wanted to append to** — use
[[vector-store]] (`vector-store stage run --append`) which exposes an
explicit `--append` flag, or inspect `retriever local stage6 run --help`
for the stage-level equivalent.
```
Reviews (1): Last reviewed commit: "add per-stage references for skill" | Re-trigger Greptile
| use [[vector-store]] (`vector-store stage run --overwrite`) on the | ||
| embeddings stage of the [[local]] flow. |
There was a problem hiding this comment.
Since
--overwrite is the default for vector-store stage run, explicitly passing it adds no effect and may suggest to readers that it's a non-default option. Dropping the flag makes the example cleaner and avoids a misleading implication.
| use [[vector-store]] (`vector-store stage run --overwrite`) on the | |
| embeddings stage of the [[local]] flow. | |
| use [[vector-store]] (`vector-store stage run`) on the | |
| embeddings stage of the [[local]] flow. |
Prompt To Fix With AI
This is a comment left during a code review.
Path: .claude/skills/nemo-retriever/references/ingest.md
Line: 99-100
Comment:
Since `--overwrite` is the default for `vector-store stage run`, explicitly passing it adds no effect and may suggest to readers that it's a non-default option. Dropping the flag makes the example cleaner and avoids a misleading implication.
```suggestion
use [[vector-store]] (`vector-store stage run`) on the
embeddings stage of the [[local]] flow.
```
How can I resolve this? If you propose a fix, please make it concise.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| - **`stage6` overwrites a table I wanted to append to** — pass the | ||
| stage-appropriate flag, or use [[vector-store]] which has explicit | ||
| `--append`. |
There was a problem hiding this comment.
The failure mode says "pass the stage-appropriate flag" but never names it, leaving Claude (and human readers) without actionable guidance. If stage6 exposes something like
--append or --overwrite, naming it here prevents a fruitless --help hunt.
| - **`stage6` overwrites a table I wanted to append to** — pass the | |
| stage-appropriate flag, or use [[vector-store]] which has explicit | |
| `--append`. | |
| - **`stage6` overwrites a table I wanted to append to** — use | |
| [[vector-store]] (`vector-store stage run --append`) which exposes an | |
| explicit `--append` flag, or inspect `retriever local stage6 run --help` | |
| for the stage-level equivalent. |
Prompt To Fix With AI
This is a comment left during a code review.
Path: .claude/skills/nemo-retriever/references/local.md
Line: 79-81
Comment:
The failure mode says "pass the stage-appropriate flag" but never names it, leaving Claude (and human readers) without actionable guidance. If stage6 exposes something like `--append` or `--overwrite`, naming it here prevents a fruitless `--help` hunt.
```suggestion
- **`stage6` overwrites a table I wanted to append to** — use
[[vector-store]] (`vector-store stage run --append`) which exposes an
explicit `--append` flag, or inspect `retriever local stage6 run --help`
for the stage-level equivalent.
```
How can I resolve this? If you propose a fix, please make it concise.
Description
Checklist