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

Advertise matrix-org.github.io/synapse docs #10595

Merged
merged 12 commits into from
Aug 31, 2021
Merged

Advertise matrix-org.github.io/synapse docs #10595

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
6f65c74
Advertise matrix-org.github.io/synapse docs
Aug 13, 2021
034b163
Changelog
Aug 13, 2021
7eec2f7
Add badge for documentation
Aug 13, 2021
d8edf11
Rephrase the dev section; provide specific links
Aug 13, 2021
33dfc1e
Switcheroo the two contributing files
Aug 17, 2021
ba160a9
Let Javascript autogenerate the TOC; typo fix
Aug 17, 2021
4ecc2ca
Prod people to render the book.
Aug 17, 2021
6e63986
Merge branch 'develop' into dmr/link-to-rendered-docs
Aug 23, 2021
7e8ce2a
Update docs/development/contributing_guide.md
Aug 24, 2021
0edd25f
Fix various links in contrib guide
Aug 24, 2021
39396e0
`docs` -> docs
Aug 31, 2021
32cfc20
Merge branch 'develop' of github.com:matrix-org/synapse into dmr/link…
Aug 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions docs/development/contributing_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,24 +74,27 @@ to work on.

# 7. Turn coffee into code and documentation!

There is a growing amount of documentation located in the `docs`
There is a growing amount of documentation located in the
[`docs`](https://github.com/matrix-org/synapse/tree/develop/docs)
directory, with a rendered version [available online](https://matrix-org.github.io/synapse).
This documentation is intended primarily for sysadmins running their
own Synapse instance, as well as developers interacting externally with
Synapse. [`docs/development`](docs/development) exists primarily to house documentation for
Synapse developers. [`docs/admin_api`](docs/admin_api) houses documentation
Synapse.
[`docs/development`](https://github.com/matrix-org/synapse/tree/develop/docs/development)
exists primarily to house documentation for
Synapse developers.
[`docs/admin_api`](https://github.com/matrix-org/synapse/tree/develop/docs/admin_api) houses documentation
regarding Synapse's Admin API, which is used mostly by sysadmins and external
service developers.

Synapse's code style is documented [here](docs/code_style.md). Please follow
Synapse's code style is documented [here](../code_style.md). Please follow
it, including the conventions for the [sample configuration
file](docs/code_style.md#configuration-file-format).
file](../code_style.md#configuration-file-format).

We welcome improvements and additions to our documentation itself! When
writing new pages, please
[build `docs` to a book](https://github.com/matrix-org/synapse/tree/develop/docs#adding-to-the-documentation)
to check that your contributions render correctly. Speaking of Markdown,
we use
to check that your contributions render correctly. The `docs` are written in
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the point of surrounding docs in code tags here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There isn't one really. I guess it's a hint that they're kept in the docs directory. But it's not a very clear hint. I'll remove this.

[GitHub-Flavoured Markdown](https://guides.github.com/features/mastering-markdown/).

Some documentation also exists in [Synapse's GitHub
Expand Down Expand Up @@ -412,7 +415,7 @@ By now, you know the drill!
# Notes for maintainers on merging PRs etc

There are some notes for those with commit access to the project on how we
manage git [here](docs/development/git.md).
manage git [here](git.md).

# Conclusion

Expand Down