Skip to content

Repository Review and Documentation Cleanup#1

Open
khamidov17 wants to merge 2 commits intomainfrom
repo-review-and-cleanup-13604379581516088953
Open

Repository Review and Documentation Cleanup#1
khamidov17 wants to merge 2 commits intomainfrom
repo-review-and-cleanup-13604379581516088953

Conversation

@khamidov17
Copy link
Copy Markdown
Owner

I have completed a comprehensive review of the vpstack repository and implemented several key improvements to stabilize the project and align the documentation with the current architecture.

Key Changes:

  • Documentation Cleanup: Updated DESIGN.md and CLAUDE.md to remove stale references to an MCP server and a defunct mcp-server/ directory. The architecture is now accurately described as a "Markdown Skills + Bash Binaries" model.
  • CI Stabilization: Fixed the GitHub Actions workflow (.github/workflows/ci.yml) which was previously failing due to attempts to install non-existent local packages.
  • New Test Suite: Created the tests/ directory and implemented the first set of automated smoke tests for bin/vpstack-detect and bin/vpstack-config, ensuring basic orchestration primitives work as expected.
  • Version Sync: Adjusted the CI metadata sanity check to accurately verify version consistency between the VERSION file and package.json.

These changes fulfill the major requirements of the repository review and provide a solid foundation for the v0.3.0 development cycle.


PR created automatically by Jules for task 13604379581516088953 started by @khamidov17

- Refactored DESIGN.md and CLAUDE.md to reflect the current bash+skills architecture and remove defunct MCP server references.
- Fixed broken CI pipeline by removing non-existent package installations and stale test markers.
- Bootstrapped a functional smoke test suite in tests/ for vpstack-detect and vpstack-config.
- Updated package-lint CI job to correctly validate version synchronization.

Co-authored-by: khamidov17 <184615772+khamidov17@users.noreply.github.com>
@google-labs-jules
Copy link
Copy Markdown

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

- Expanded automated test suite with `tests/test_binaries.py` for `vpstack-b1` smoke tests.
- Replaced all stale references to `/tmp/vp_b1_run.py` with `vpstack-b1` binary across docs and skills.
- Cleaned up defunct `mcp-server` and `speechbrain_voice_anon` references in DESIGN.md, TEST-PLAN.md, and CI/CD workflows.
- Added CONTRIBUTING.md and requirements-test.txt for better developer onboarding.
- Standardized release and CI/CD workflows to focus solely on the npm-distributed package.

Co-authored-by: khamidov17 <184615772+khamidov17@users.noreply.github.com>
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.

1 participant