Bring README and copilot-instructions up to date with proper configuration documentation #6
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses the incomplete and outdated documentation in both README.md and copilot-instructions.md, with particular focus on the "Configuration Options" section that was cutting off mid-sentence.
Key improvements made:
📝 Fixed incomplete Configuration Options section
The README previously had an incomplete "Configuration Options" section that ended abruptly. Now it properly documents both available input parameters:
input: Path to Dhall source directory (default:src)package-name: Package name for documentation (optional)🔧 Made workflow truly reusable
Enhanced the GitHub Actions workflow to support both
workflow_dispatchandworkflow_calltriggers with proper input definitions, allowing other repositories to actually use this as a reusable workflow.📚 Updated examples and references
@v0.1tag to@mainreference🎯 Enhanced workflow functionality
The workflow now properly accepts and forwards both
inputandpackage-nameparameters to the underlying dhall-docs action, making it fully configurable.✅ Corrected copilot-instructions
Updated the copilot-instructions.md to accurately reflect:
The workflow is now properly documented and functional as a reusable GitHub Actions workflow that other repositories can easily integrate for Dhall documentation deployment.
Fixes #5.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.