Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 4ecc2ca

Browse files
author
David Robertson
committed
Prod people to render the book.
1 parent ba160a9 commit 4ecc2ca

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/development/contributing_guide.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,12 @@ Synapse's code style is documented [here](docs/code_style.md). Please follow
8787
it, including the conventions for the [sample configuration
8888
file](docs/code_style.md#configuration-file-format).
8989

90-
If you add new files to our documentation, please use [GitHub-Flavoured
91-
Markdown](https://guides.github.com/features/mastering-markdown/).
90+
We welcome improvements and additions to our documentation itself! When
91+
writing new pages, please
92+
[build `docs` to a book](https://github.com/matrix-org/synapse/tree/develop/docs#adding-to-the-documentation)
93+
to check that your contributions render correctly. Speaking of Markdown,
94+
we use
95+
[GitHub-Flavoured Markdown](https://guides.github.com/features/mastering-markdown/).
9296

9397
Some documentation also exists in [Synapse's GitHub
9498
Wiki](https://github.com/matrix-org/synapse/wiki), although this is primarily

0 commit comments

Comments
 (0)