input-output-hk / input-output-hk/constrained-generators
Merge documentation
- Dominant language
- Haskell
- Stars
- 3
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Currently we have two `.md` documents that have significant overlap with two slightly different goals:
- `Manual.md` which aims to give users a smooth introduction to using the system
- `DesignPrinciples.md` which aims to explain how the internals work
I think it would be worth while to merge these two into one document that starts off explaining how to use the system and transitions into explaining how it works, clearly marking what a _user_ needs to know and what a _maintainer_ needs to know. That way we could more easily maintain the document and it would be natural to progressively reveal more internals to users as they become more comfortable with the system.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.