Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 3, 2025

This PR adds an "In the wild" section to the README.md that showcases real-world usage of this GitHub Actions workflow for deploying Dhall documentation.

The new section includes a comprehensive example featuring the typeclasses.dhall repository, which demonstrates typical usage patterns:

  • Repository link: Direct reference to the project using this workflow
  • Workflow configuration: Link to their actual workflow file showing how they implement the reusable workflow
  • Generated documentation: Link to the live documentation site at https://nikita-volkov.github.io/typeclasses.dhall/
  • Usage context: Description of how they configure the workflow (using src/ directory, typeclasses package name, and automatic triggers)

This addition provides users with a concrete, working example that they can reference when implementing their own documentation workflows, helping them understand both the configuration and the expected output.

The section is strategically placed after the "Configuration Options" section and before "Troubleshooting" to provide a practical example that reinforces the configuration concepts just covered.

Fixes #9.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: nikita-volkov <1560937+nikita-volkov@users.noreply.github.com>
@nikita-volkov nikita-volkov marked this pull request as ready for review September 3, 2025 05:43
Copilot AI changed the title [WIP] Add examples in the readme Add "In the wild" section to README with typeclasses.dhall example Sep 3, 2025
Copilot AI requested a review from nikita-volkov September 3, 2025 05:43
Copilot finished work on behalf of nikita-volkov September 3, 2025 05:43
@nikita-volkov nikita-volkov merged commit 5cf744c into master Sep 3, 2025
@nikita-volkov nikita-volkov deleted the copilot/fix-9 branch September 3, 2025 05:44
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.

Add examples in the readme

2 participants