Skip to content

Conversation

@beonde
Copy link
Member

@beonde beonde commented Dec 2, 2025

Summary

This PR removes fabricated documentation that didn't match the actual source code.

What Was Wrong

The docs previously mentioned:

  1. CAPISCIO_CORE_PATH environment variable - This does NOT exist in the source code
  2. capiscio score command - This command does NOT exist

These were hallucinated by the documentation generator and don't reflect actual functionality.

Changes

Removed Fabricated Content

  • docs/reference/commands.md - Removed fake CAPISCIO_CORE_PATH env var
  • README.md - Removed fake capiscio score command example

Added Accurate Content

  • Documented actual wrapper-specific flags: --wrapper-version and --wrapper-clean
  • Clarified wrapper behavior: Downloads and proxies to capiscio-core binary

Verification

Verified against actual source code in capiscio_python/cli.py:

  • --wrapper-version exists
  • --wrapper-clean exists
  • CAPISCIO_CORE_PATH does NOT exist
  • capiscio score does NOT exist

Files Changed

  • README.md - Removed fake score command
  • docs/index.md - Updated wrapper description
  • docs/reference/commands.md - Removed fake env var, added real wrapper flags

Copilot AI review requested due to automatic review settings December 2, 2025 16:39
@github-actions
Copy link

github-actions bot commented Dec 2, 2025

✅ All checks passed! Ready for review.

Copy link
Contributor

Copilot AI left a 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 corrects fabricated documentation by removing non-existent features and replacing them with accurate information about the wrapper's actual functionality. The changes align the documentation with the source code in src/capiscio/cli.py and src/capiscio/manager.py.

Key Changes

  • Removed fictional CAPISCIO_CORE_PATH environment variable that doesn't exist in the source code
  • Removed fictional capiscio score command, replacing it with the actual capiscio validate --json syntax
  • Added documentation for the actual wrapper-specific flags (--wrapper-version and --wrapper-clean)

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
README.md Replaced fabricated capiscio score command with accurate capiscio validate --json command
docs/index.md Added clarification that this is a wrapper package with no validation logic, enhanced Quick Start section with accurate examples
docs/reference/commands.md Removed fabricated CAPISCIO_CORE_PATH environment variable, added accurate documentation for core commands with proper examples

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@beonde beonde merged commit 506637d into main Dec 2, 2025
12 checks passed
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.

2 participants