We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 4f13cdf commit f45b34cCopy full SHA for f45b34c
CONTRIBUTING.md
@@ -31,6 +31,17 @@ Some of the reported problems can be automatically fixed by `fix`:
31
sbt fix
32
```
33
34
+## Documentation
35
+
36
+The project contains [compiled documentation](https://scalameta.org/mdoc) which is located in [example/src/main/mdoc](example/src/main/mdoc).
37
+Please do update it with your changes and recompile it to check that everything is fine using the following command:
38
39
+```bash
40
+sbt example/mdoc
41
+```
42
43
+You should definitely recompile [mdoc] documentation
44
45
## Conventional Commits
46
47
The project uses [Conventional Commits](https://www.conventionalcommits.org) specification to have clear Git history and help with
0 commit comments