This repository was archived by the owner on Apr 26, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website #10086
Merged
Merged
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit
Hold shift + click to select a range
e453c3b
Setup; add book.toml
anoadragon453 f8f770a
Add book/ directory to .gitignore
anoadragon453 035d696
Add a favicon
anoadragon453 706f64a
Add github actions workflow to deploy docs to gh-pages
anoadragon453 99e7ffe
Organise existing documentation into a tree structure.
anoadragon453 069712e
Add some section pages
anoadragon453 db46987
Add a table of contents plugin
anoadragon453 3f9f35d
Remove chapter navigation buttons on desktop
anoadragon453 3712044
Update docs/README.md with information on the site and how to build it
anoadragon453 fe65330
Update oft-linked to admin_api directory with info about the new site
anoadragon453 b4bf418
Refine the sidebar: switch to headers without labels
anoadragon453 c6e5eaf
Changelog
anoadragon453 8d774a4
Apply suggestions from code review
anoadragon453 e9ba348
Apply suggestions from code review
anoadragon453 14cb114
Remove comments in workflow, latest -> develop
anoadragon453 b6adbd7
Split out homeserver and logging sample config files
anoadragon453 2568e5b
Move structured logging up next to the logging configuration chapter
anoadragon453 9157b8e
Don't link to register_new_matrix_user
anoadragon453 92c514f
Update docs/usage/configuration/README.md
anoadragon453 7cb4fd9
Merge branch 'develop' of github.com:matrix-org/synapse into anoa/mdbook
anoadragon453 170fed8
Switch admin_api SUMMARY entries to their markdown versions; fix link…
anoadragon453 2b39299
Feature Documentation -> Internal Documentation
anoadragon453 071a6ef
Add Media Storage Providers draft chapter
anoadragon453 90520ae
Update mdbooks to 0.4.9; re-enable edit button
anoadragon453 f896a1b
Drop 'Writing a Module' chapter draft until new module API exists
anoadragon453 6991e88
Fix links to documentation
anoadragon453 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# Summary | ||
|
||
- [Introduction](welcome_and_overview.md) | ||
- [Setup]() | ||
- [Installation](setup/installation.md) | ||
- [Using Postgres](postgres.md) | ||
- [Configuring a Reverse Proxy](reverse_proxy.md) | ||
- [Configuring a Turn Server](turn-howto.md) | ||
- [Delegation](delegate.md) | ||
- [Upgrading](upgrading/README.md) | ||
- [Upgrading from pre-Synapse 1.0](MSC1711_certificates_FAQ.md) | ||
- [Usage]() | ||
- [Federation](federate.md) | ||
- [Configuration]() | ||
- [Sample Configuration Files](usage/configuration/sample_config.md) | ||
- [User Authentication]() | ||
- [Single-Sign On]() | ||
- [OpenID Connect](openid.md) | ||
- [SAML]() | ||
- [CAS]() | ||
- [SSO Mapping Providers](sso_mapping_providers.md) | ||
- [Password Auth Providers](password_auth_providers.md) | ||
- [JSON Web Tokens](jwt.md) | ||
- [Registration Captcha](CAPTCHA_SETUP.md) | ||
- [Application Services](application_services.md) | ||
- [Server Notices](server_notices.md) | ||
- [Consent Tracking](consent_tracking.md) | ||
- [URL Previews](url_previews.md) | ||
- [User Directory](user_directory.md) | ||
- [Message Retention Policies](message_retention_policies.md) | ||
- [Pluggable Modules]() | ||
- [Third Party Rules]() | ||
- [Spam Checker](spam_checker.md) | ||
- [Presence Router](presence_router_module.md) | ||
- [Writing a Module]() | ||
- [Workers](workers.md) | ||
- [Using `synctl` with Workers](synctl_workers.md) | ||
- [Systemd](systemd-with-workers/README.md) | ||
- [Administration](usage/administration/README.md) | ||
- [Admin API](usage/administration/admin_api/README.md) | ||
- [Account Validity](admin_api/account_validity.rst) | ||
- [Delete Group](admin_api/delete_group.md) | ||
- [Event Reports](admin_api/event_reports.md) | ||
- [Media](admin_api/media_admin_api.md) | ||
- [Purge History](admin_api/purge_history_api.rst) | ||
- [Purge Rooms](admin_api/purge_room.md) | ||
- [Register Users](admin_api/register_api.rst) | ||
- [Manipulate Room Membership](admin_api/room_membership.md) | ||
- [Rooms](admin_api/rooms.md) | ||
- [Server Notices](admin_api/server_notices.md) | ||
- [Shutdown Room](admin_api/shutdown_room.md) | ||
- [Statistics](admin_api/statistics.md) | ||
- [Users](admin_api/user_admin_api.rst) | ||
- [Server Version](admin_api/version_api.rst) | ||
anoadragon453 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- [Manhole](manhole.md) | ||
- [Monitoring](metrics-howto.md) | ||
- [Structured Logging](structured_logging.md) | ||
anoadragon453 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- [Scripts]() | ||
- [Development]() | ||
- [Contributing Guide](development/contributing_guide.md) | ||
- [Code Style](code_style.md) | ||
- [Git Usage](dev/git.md) | ||
- [Testing]() | ||
- [OpenTracing](opentracing.md) | ||
- [Synapse Architecture]() | ||
- [Log Contexts](log_contexts.md) | ||
- [Replication](replication.md) | ||
- [TCP Replication](tcp_replication.md) | ||
- [Feature Documentation]() | ||
- [Single Sign-On]() | ||
- [SAML](dev/saml.md) | ||
- [CAS](dev/cas.md) | ||
- [State Resolution]() | ||
- [The Auth Chain Difference Algorithm](auth_chain_difference_algorithm.md) | ||
- [Media Repository](media_repository.md) | ||
- [Room and User Statistics](room_and_user_statistics.md) | ||
- [Scripts]() | ||
- [Other]() | ||
- [Dependency Deprecation Policy](deprecation_policy.md) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Introduction | ||
|
||
Welcome to the documentation repository for Synapse, the reference | ||
[Matrix](https://matrix.org) homeserver implementation. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.