Skip to content

Comments

Add markdown file support to job steps#19

Merged
nhorton merged 6 commits intomainfrom
claude/add-step-markdown-files-X0WII
Jan 14, 2026
Merged

Add markdown file support to job steps#19
nhorton merged 6 commits intomainfrom
claude/add-step-markdown-files-X0WII

Conversation

@nhorton
Copy link
Contributor

@nhorton nhorton commented Jan 14, 2026

Step instructions can now reference additional .md files placed in the steps/ directory. When slash commands are generated, references to these files (in backticks, markdown links, or quoted strings) are automatically transformed to relative paths from the project root.

Changes:

  • Add _find_supplementary_files() to detect extra .md files in steps dir
  • Add _transform_md_references() to convert filename refs to full paths
  • Update Claude and Gemini templates to show supplementary files section
  • Document the feature in implement.md for deepwork_jobs
  • Add comprehensive tests for the new functionality

Step instructions can now reference additional .md files placed in the
steps/ directory. When slash commands are generated, references to these
files (in backticks, markdown links, or quoted strings) are automatically
transformed to relative paths from the project root.

Changes:
- Add _find_supplementary_files() to detect extra .md files in steps dir
- Add _transform_md_references() to convert filename refs to full paths
- Update Claude and Gemini templates to show supplementary files section
- Document the feature in implement.md for deepwork_jobs
- Add comprehensive tests for the new functionality
@github-actions
Copy link
Contributor

github-actions bot commented Jan 14, 2026


Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you all sign our Developer Certificate of Origin before we can accept your contribution. You can sign the DCO by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


2 out of 3 committers have signed the DCO.
✅ (nhorton)[https://github.com/nhorton]
✅ (nhorton)[https://github.com/nhorton]
@claude
You can retrigger this bot by commenting recheck in this Pull Request. Posted by the DCO Assistant Lite bot.

claude and others added 3 commits January 14, 2026 18:10
Remove automatic path transformation code in favor of documenting that
users should reference supplementary files using full paths from the
project root (e.g., .deepwork/jobs/job_name/steps/reference.md).

This is simpler and more explicit - no magic transformations needed.

Changes:
- Remove _find_supplementary_files() and _transform_md_references() from generator
- Remove supplementary_files template section from both Claude and Gemini templates
- Remove supplementary files tests
- Add supplemental_file_references.md documentation file
- Update implement.md to reference the new doc file with full path
The .deepwork/ directory should only be modified by `deepwork install`,
not by manual file copies. Remove the supplementary files that were
incorrectly added to the installed jobs directory.

The supplementary file documentation remains in the source at
src/deepwork/standard_jobs/deepwork_jobs/steps/ and will be installed
when users run `deepwork install`.
@nhorton
Copy link
Contributor Author

nhorton commented Jan 14, 2026

I have read the CLA Document and I hereby sign the CLA

@nhorton
Copy link
Contributor Author

nhorton commented Jan 14, 2026

I have read the CLA Document and I hereby sign the CLA

@nhorton nhorton merged commit 89d3dac into main Jan 14, 2026
1 of 2 checks passed
@nhorton nhorton deleted the claude/add-step-markdown-files-X0WII branch January 14, 2026 21:49
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