Skip to content

Add "In the wild" section to README with typeclasses.dhall example #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 3, 2025
Merged

Add "In the wild" section to README with typeclasses.dhall example #10

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3fc83dc
Initial plan
Copilot Sep 3, 2025
4ce0cb0
Add "In the wild" section with typeclasses.dhall example
Copilot Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,20 @@ jobs:
package-name: my-awesome-dhall-library
```

## In the Wild

Here are some real-world examples of projects using this workflow:

### [typeclasses.dhall](https://github.com/nikita-volkov/typeclasses.dhall)

A comprehensive typeclass library for the Dhall configuration language. This project demonstrates typical usage of the workflow:

- **Repository**: [nikita-volkov/typeclasses.dhall](https://github.com/nikita-volkov/typeclasses.dhall)
- **Workflow Configuration**: [deploy-docs-to-pages.yaml](https://github.com/nikita-volkov/typeclasses.dhall/blob/master/.github/workflows/deploy-docs-to-pages.yaml)
- **Generated Documentation**: [nikita-volkov.github.io/typeclasses.dhall](https://nikita-volkov.github.io/typeclasses.dhall/)

The project uses this workflow to automatically generate and deploy documentation from Dhall source files located in the `src/` directory, with `typeclasses` as the package name. The workflow triggers on pushes to the main branch and can also be run manually.

## Troubleshooting

### Common Issues
Expand Down