Skip to content

docs: clarify Java API selector requirements in pipeline-commands #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
detail-app wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

docs: clarify Java API selector requirements in pipeline-commands #79

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/pipeline-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ make process-github-repo # GitHub repo ingestion (REPO_PATH / REPO_URL / SYNC_E

| Flag | Effect |
|---|---|
| `--doc-sets=...` | Comma-separated doc set IDs or paths to process (see [doc set filtering](#doc-set-filtering)) |
| `--doc-sets=...` | Comma-separated doc set paths (or IDs for non-Java sets) to process (see [doc set filtering](#doc-set-filtering)) |
| `--help` | Show usage |

## GitHub repository ingestion
Expand Down Expand Up @@ -118,14 +118,14 @@ GitHub ingestion runs in headless CLI mode (`spring.main.web-application-type=no

### Doc set filtering

Limit ingestion to specific doc sets by ID or path:
Limit ingestion to specific doc sets by path. Non-Java sets also accept short IDs (hyphenated paths); Java API sets require the exact canonical path from the listing command:

```bash
# Complete Java API paths: copy relativeMirrorPath from the listing command
./scripts/fetch_all_docs.sh --list-java-api-sources
DOCS_SETS=relative/path/from/listing make process-doc-sets

# Non-Java example
# Non-Java example (accepts ID or path)
./scripts/process_all_to_qdrant.sh --doc-sets=spring-boot-complete
```

Expand Down