Skip to content

Commit f45b34c

Browse files
committed
docs: Add a note about compiled documentation to contributing guide
1 parent 4f13cdf commit f45b34c

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,17 @@ Some of the reported problems can be automatically fixed by `fix`:
3131
sbt fix
3232
```
3333

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+
3445
## Conventional Commits
3546

3647
The project uses [Conventional Commits](https://www.conventionalcommits.org) specification to have clear Git history and help with

0 commit comments

Comments
 (0)