docs: align CLI-first docs and note Apache AGE graph transition#105
docs: align CLI-first docs and note Apache AGE graph transition#105
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 30d7a76fbf
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
Follow-up tracking issue created for AGE-based graph expansion reintroduction: #106 This keeps the current docs/transition PR focused while implementation planning proceeds separately. |
There was a problem hiding this comment.
Pull request overview
This PR updates documentation across multiple files to align with the CLI-first approach and document the transition from Neo4j/Qdrant to Postgres-based storage with planned Apache AGE graph extension support.
Changes:
- Unified skill documentation to emphasize CLI usage over direct API calls, updating all command examples from curl to the Node.js CLI
- Updated provider documentation to clarify support for Ollama, OpenAI, and Anthropic for embeddings and enrichment
- Documented removal of
graphExpandquery parameter and transition plan to Apache AGE on Postgres for graph capabilities
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| skill/skills/raged/SKILL.md | Updated to CLI-first approach with current command flags and provider details |
| skill/SKILL.md | Synchronized duplicate of skills/raged/SKILL.md with same updates |
| skill/README.md | Updated prerequisites to reflect Node.js/npm requirement and provider options |
| docs/04-claude-skills.md | Updated agent integration docs to reflect CLI-first approach |
| docs/03-cli.md | Comprehensive update of CLI command flags including new query options |
| docs/01-architecture.md | Added note about graphExpand removal and Apache AGE transition |
| docs/00-vision.md | Updated vision and roadmap to reflect relationship layer terminology |
| README.md | Updated main description to clarify provider support and graph transition |
Comments suppressed due to low confidence (2)
docs/04-claude-skills.md:76
- The indentation for these participant declarations is inconsistent with the rest of the mermaid diagram. Lines 72-74 use 4 spaces for indentation, but lines 75-76 use only 2 spaces. For consistency, these lines should use 4 spaces of indentation like the other participant declarations in the diagram.
participant CLI as raged CLI
participant API as RAG API
docs/04-claude-skills.md:80
- This line has inconsistent indentation (2 spaces instead of 4). For consistency with the rest of the mermaid diagram, this should use 4 spaces of indentation.
S->>CLI: node dist/index.js query --q "deployment strategy"
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.
Comments suppressed due to low confidence (2)
skill/skills/raged/SKILL.md:126
--uniqueis used in the example query above, but it isn’t listed in the Query Parameters table. Add--unique(and any other CLI-only flags you expect skill users to rely on) to keep the table consistent with the examples.
| `--repoId` | string | _(none)_ | Filter by repository ID |
| `--lang` | string | _(none)_ | Filter by language |
| `--pathPrefix` | string | _(none)_ | Filter by file path prefix |
| `--summary [level]` | flag/string | _(none)_ | Show summary (`short`, `medium`, `long`) |
| `--keywords` | flag | `false` | Show extracted keywords |
skill/SKILL.md:126
--uniqueappears in the example query (--unique) but is missing from the Query Parameters table. Please document it there (and any other supported flags referenced by examples) so users don’t have to infer behavior.
| `--repoId` | string | _(none)_ | Filter by repository ID |
| `--lang` | string | _(none)_ | Filter by language |
| `--pathPrefix` | string | _(none)_ | Filter by file path prefix |
| `--summary [level]` | flag/string | _(none)_ | Show summary (`short`, `medium`, `long`) |
| `--keywords` | flag | `false` | Show extracted keywords |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@copilot let's address the review comments |
|
@copilot review |
Summary
Scope
Documentation-only changes across README, docs, and skill docs.