From 45d1ff2c817c1f31a8d023c77108c10679d653bc Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Wed, 19 Jun 2024 11:04:13 +0100 Subject: [PATCH 1/5] Remove table of contents from the README With the top-level header, the auto-generated TOC is pretty ugly. We could manually include a TOC, but we'd need to keep it up to date. GitHub generates a TOC already - just hit the Outline button. --- README.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.rst b/README.rst index db9b79a237a..d08be402661 100644 --- a/README.rst +++ b/README.rst @@ -25,8 +25,6 @@ deployment. It includes advanced identity management, auditing, moderation and data retention options as well as Long Term Support and SLAs. ESS can be used to support any Matrix-based frontend client. -.. contents:: - 🛠️ Installing and configuration =============================== From 347b1da7293fd298b23ebe252d071eefbd8ef8c0 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Wed, 19 Jun 2024 11:06:23 +0100 Subject: [PATCH 2/5] changelog --- changelog.d/17329.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/17329.doc diff --git a/changelog.d/17329.doc b/changelog.d/17329.doc new file mode 100644 index 00000000000..47ee489bfa3 --- /dev/null +++ b/changelog.d/17329.doc @@ -0,0 +1 @@ +Remove the auto-generated table of contents from the README. \ No newline at end of file From 7aff0258ae1908f26d99e9d0e156725de498b29d Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Tue, 25 Jun 2024 16:03:30 +0100 Subject: [PATCH 3/5] Revert "Remove table of contents from the README" This reverts commit 45d1ff2c817c1f31a8d023c77108c10679d653bc. --- README.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.rst b/README.rst index d08be402661..db9b79a237a 100644 --- a/README.rst +++ b/README.rst @@ -25,6 +25,8 @@ deployment. It includes advanced identity management, auditing, moderation and data retention options as well as Long Term Support and SLAs. ESS can be used to support any Matrix-based frontend client. +.. contents:: + 🛠️ Installing and configuration =============================== From a4c0b522859773c26b5c48e7517a7171a9f24d5b Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Tue, 25 Jun 2024 16:04:44 +0100 Subject: [PATCH 4/5] Modify headers to fix ToC This commit removes the repo name as a header, as to prevent it from ending up in the ToC. It also changes the header level for "Subscription alternative", preventing "Installing and Configuration" from ending up underneath. --- README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index db9b79a237a..145315a7fe6 100644 --- a/README.rst +++ b/README.rst @@ -1,9 +1,9 @@ .. image:: https://github.com/element-hq/product/assets/87339233/7abf477a-5277-47f3-be44-ea44917d8ed7 :height: 60px -=========================================================================================================== -Element Synapse - Matrix homeserver implementation |support| |development| |documentation| |license| |pypi| |python| -=========================================================================================================== +**Element Synapse - Matrix homeserver implementation** + +|support| |development| |documentation| |license| |pypi| |python| Synapse is an open source `Matrix `_ homeserver implementation, written and maintained by `Element `_. @@ -14,7 +14,7 @@ license. There is no support provided from Element unless you have a subscription. Subscription alternative ------------------------- +======================== Alternatively, for those that need an enterprise-ready solution, Element Server Suite (ESS) is `available as a subscription `_. From 849cd9ea3d8e7b192610d062b5ab0c9e2f74cfa7 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Tue, 25 Jun 2024 16:08:00 +0100 Subject: [PATCH 5/5] Update changelog --- changelog.d/17329.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/17329.doc b/changelog.d/17329.doc index 47ee489bfa3..2486256dadc 100644 --- a/changelog.d/17329.doc +++ b/changelog.d/17329.doc @@ -1 +1 @@ -Remove the auto-generated table of contents from the README. \ No newline at end of file +Update header in the README to visually fix the the auto-generated table of contents. \ No newline at end of file