Skip to content
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.

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

Three tiered documentation #67

Open
vil1 opened this issue Sep 23, 2019 · 0 comments
Open

Three tiered documentation #67

vil1 opened this issue Sep 23, 2019 · 0 comments
Labels

Comments

@vil1
Copy link
Member

vil1 commented Sep 23, 2019

Before releasing a first version, we must provide a three-tiered documentation, each tier targeting a specific "level" of interaction with the library.

  • User : the general philosophy behind the library, its intended purpose and goals; step-by-step descriptions of the most common use-cases (typeclass derivation, schema evolution), for every provided module.
  • Power-user : how to extend the library, how the derivation mechanism works internally and how to create new modules and interpreters, how the migration mechanism works and how to implement new/custom migrations.
  • Contributor : the design decisions that have lead to the current implementation and the reasons behind them, and more generally anything that is useful to know before contributing to the core of the library.
@vil1 vil1 added the mvp label Sep 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant