Skip to content

feat(cli): bundle workflow guides and add dpdisp skills - #688

Open
njzjz-bot wants to merge 4 commits into
deepmodeling:masterfrom
njzjz-bot:agent-dot/bundled-skills-cli-20261024
Open

njzjz-bot wants to merge 4 commits into
deepmodeling:masterfrom
njzjz-bot:agent-dot/bundled-skills-cli-20261024

Conversation

@njzjz-bot

@njzjz-bot njzjz-bot commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Bundle public workflow guides as offline, version-matched package resources.
  • Expose read-only documentation discovery via dpdisp skills list and dpdisp skills read <name> [relative-path].
  • Integrate relevant guide pointers into CLI help and retain existing CLI behavior.
  • Add packaging support and regression tests for resource lookup, safe reading, and help output.

Documentation

  • Document the new commands in the existing dedicated reference: doc/agent-skills.md.
  • Keep the main README.md unchanged relative to upstream; use the existing docs navigation instead.
  • Distinguish reading installed guides from installing skills into an AI agent or executing workflows.

Validation

  • Added tests/test_skills.py and tests/test_skill_help.py.
  • Tests were reported completed before PR submission; no test rerun is claimed for the later documentation-only refinement.

Provenance

  • Original implementation: njzjz-bot:agent-dot/bundled-skills-cli-20261024.
  • PR opened and documentation placement refined by ChatGPT (GPT-6).
  • Documentation follow-up commits record the agent and model; no feature code was changed during documentation refinement.

@codecov

codecov Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.35%. Comparing base (3b42422) to head (e98078e).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #688      +/-   ##
==========================================
+ Coverage   75.91%   76.35%   +0.44%     
==========================================
  Files          42       43       +1     
  Lines        5427     5503      +76     
==========================================
+ Hits         4120     4202      +82     
+ Misses       1307     1301       -6     
Flag Coverage Δ
optional-dependencies 76.04% <100.00%> (+0.44%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitai

coderabbitai Bot commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 36 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 8fbd6e7f-cb46-47ce-bc65-0c48aa7e92a2
Commits

Reviewing files that changed from the base of the PR and between f35cba0 and e98078e.

Files selected for processing: 3
  • doc/agent-skills.md
  • dpdispatcher/skills.py
  • tests/test_skills.py

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: e33d7559-2b6e-43d8-bbf0-b5bd2fdf1b95
Commits

Reviewing files that changed from the base of the PR and between 3b42422 and f35cba0.

Files selected for processing: 10
  • MANIFEST.in
  • README.md
  • dpdispatcher/__init__.py
  • dpdispatcher/base_context.py
  • dpdispatcher/dpdisp.py
  • dpdispatcher/machine.py
  • dpdispatcher/skills.py
  • setup.py
  • tests/test_skill_help.py
  • tests/test_skills.py

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The package now includes workflow guides and provides commands to list and read them offline. The CLI adds guide hints to run and submit help. Runtime objects and backend implementations load when their modules or package attributes are accessed.

Changes: Workflow guide CLI

Layer / File(s) Summary
Runtime object and backend registration
dpdispatcher/__init__.py, dpdispatcher/base_context.py, dpdispatcher/machine.py, tests/test_skills.py
Package-level runtime objects load on access. Importing base_context or machine loads the corresponding backend package. Tests check package exports and backend registration.
Bundle and read workflow guides
MANIFEST.in, setup.py, dpdispatcher/skills.py, README.md, tests/test_skills.py
The build includes guide files in the package. The skills module locates, lists, and reads guides, and rejects invalid or escaping paths. Tests cover guide access, path validation, and home-directory behavior.
CLI commands and contextual help
dpdispatcher/dpdisp.py, dpdispatcher/skills.py, tests/test_skill_help.py, tests/test_skills.py
The CLI registers and dispatches skills list and skills read. The run and submit help output includes a guide hint. Tests cover help output and existing submit argument parsing.

Priority: Normal

Estimated code review effort: 3 (Moderate) | ~25 minutes

Change: Feature

Sequence Diagram(s)

sequenceDiagram
  participant Parser as dpdispatcher.dpdisp.main_parser
  participant Dispatch as dpdispatcher.dpdisp.main
  participant Skills as dpdispatcher.skills.run
  participant Reader as dpdispatcher.skills.read_skill
  participant Files as Skills directory
  Parser->>Parser: Register skills list and skills read
  Dispatch->>Skills: Pass parsed skills command
  Skills->>Reader: Pass skill name and reference path
  Reader->>Files: Read validated guide file
  Files-->>Reader: Return UTF-8 content
  Reader-->>Skills: Return guide content
  Skills-->>Dispatch: Print guide content
Loading

Suggested reviewers: njzjz

Merge Risk: Minimal · up to f35cb

No concrete issue currently blocks merging. Complete the normal build and test checks before release.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 55.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 20 functions across 8 files. (2 skipped: … Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "feat(cli): bundle workflow guides and add dpdisp skills" matches the main change. The PR bundles the workflow guides in the package (MANIFEST.in, setup.py build_py, skills.py) and adds th…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "feat(cli): bundle workflow guides and add dpdisp skills" matches the main change. The PR bundles the workflow guides in the package (MANIFEST.in, setup.py build_py, skills.py) and adds the dpdisp skills list and dpdisp skills read CLI subcommands (dpdisp.py, skills.py). The title is concise, specific, and follows the conventional-commit style. The remaining changes (lazy imports in init.py, base_context.py, machine.py, and the README update) support the main change but are not named in the title, which is expected.

Full details: Docstring Coverage

Explanation

Docstring coverage is 55.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 20 functions across 8 files. (2 skipped: 2 unsupported.)

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Keep the main README concise; distinguish local documentation reads from agent installation.

Agent: ChatGPT
Model: GPT-6
Fix the test portability error on macOS /var paths; production behavior is unchanged.

Agent: dot

This branch has not been deployed

No deployments
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