-
Notifications
You must be signed in to change notification settings - Fork 0
docs: Clarify CLI-wrapper-only architecture #28
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR restructures the documentation to clarify that the capiscio npm package is a CLI wrapper only for the Go-based capiscio-core binary, not a native TypeScript/JavaScript SDK. The changes remove outdated API documentation and focus on CLI usage with programmatic access via child process spawning.
Key changes:
- Simplified documentation structure removing architecture and process docs
- New comprehensive CLI reference with all flags and examples
- Updated programmatic usage guide to demonstrate spawning CLI as child process
- Clarified scoring guide to focus on parsing CLI JSON output
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Updated navigation: removed API Reference and Architecture, added CLI Reference |
| docs/validation-process.md | Deleted - removed detailed validation process documentation |
| docs/scoring-system.md | Deleted - removed detailed scoring system documentation |
| docs/reference/architecture.md | Deleted - removed TypeScript architecture documentation |
| docs/reference/cli.md | New file - comprehensive CLI reference with all 28 flags and usage examples |
| docs/reference/api.md | Updated - now describes TypeScript API as available but focuses on CLI wrapper approach |
| docs/index.md | Rewritten - clearly states this is a CLI wrapper with binary distribution model |
| docs/guides/scoring.md | Updated - focused on CLI JSON output parsing and CI/CD integration |
| docs/guides/programmatic-usage.md | Rewritten - demonstrates child process approach instead of TypeScript API |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Fix broken links in api.md (scoring.md, programmatic-usage.md → guides folder) - Fix command injection vulnerability: replace execSync with spawnSync - Fix async example: replace exec with spawn - Fix Express middleware: use spawnSync instead of execSync - Fix emoji encoding issue (�� → 🔐) in scoring.md - Remove broken getting-started link in scoring.md - Fix circular reference in cli.md See Also section - Remove irrelevant Python SDK reference from Node.js docs
Summary
This PR clarifies that capiscio-node is a CLI wrapper only - it does not expose a TypeScript/JavaScript API for programmatic validation.
Changes
Documentation Updates
Key Clarification
What This Means for Users
capiscio validatefrom terminalFiles Changed
docs/index.md- Rewrote to clarify wrapper naturedocs/reference/cli.md- New complete CLI referencedocs/reference/architecture.md- Deleteddocs/reference/api.md- Cleared (A2AValidator unsupported)docs/guides/programmatic-usage.md- Child process approachdocs/guides/scoring.md- CLI JSON parsingmkdocs.yml- Simplified nav