Commit Graph

29 Commits (1e47d7ec48142ae7192f9199bd9f359ef09d2b63)

Author SHA1 Message Date
Kévin Commaille 3af77f0cb4
Fix the table of content for room versions (#1884)
* Fix ToC for room versions pages

Like for the cs-module shortcode, use .RenderShortcodes
instead of .Content for the rver-fragment shortcode,
so the headings are detected by Hugo.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Change the way "this version" is detected in added-in and changed-in shortcodes

Now that we use .RenderShortcodes in the rver-fragment shortcode,
we cannot remove the output of these shortcodes dynamically
because they are replaced by a temporary placeholder due to Hugo's internals.

Instead, since the `this` parameter was only used for room version,
we always use the `v` parameter and compare with the version
provided in the page's front matter.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add version front matter for v11

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Update changelogs/room_versions/newsfragments/1884.clarification

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Travis Ralston <travpc@gmail.com>
4 months ago
Kévin Commaille 9fe119370b
Update typos action and fix typos (#1661)
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
1 year ago
Travis Ralston 903b206e3b
Specify our usage of ABNF for grammar (#1582)
* Specify our usage of ABNF for grammar

* Create 1582.clarification

* Update meta/documentation_style.rst

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

---------

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
1 year ago
Richard van der Hoff a45138c3b4
Minor updates to documentation style (#1456)
i.e. has full-stops
2 years ago
Travis Ralston d4c74d37a9
Update documentation style & fix room version heading order (#3683)
* Update documentation style & fix room version heading order

Also add a missing signing key section to v6.

This additionally contains various edits to the fragments to have them make a little bit more sense in context.

Finally, this updates various aspects of the documentation style which haven't previously been considered - they're added here considering we're in the area.

* changelog

* enhanced changelogs

* Minor wording adjustments

* Apply suggestions from code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
3 years ago
Richard van der Hoff cafb9ff5a8 Update documentation_style.rst (#3352) 3 years ago
Richard van der Hoff 6afe10409e Update documentation_style.rst (#3351)
hugo tales commonmark.
3 years ago
Travis Ralston 62896cdea9 Apply suggestions from code review
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
3 years ago
Travis Ralston 52cd88f070 Rewrite readme and update contributor docs
Incorporates https://github.com/matrix-org/matrix-doc/pull/3025/
3 years ago
Richard van der Hoff ae163ab818
remove some lies about markdown being bad (#2337) 5 years ago
Travis Ralston 7d34995ece It's actually an "identity server implementing the Identity Service API"
Also add a note about appservices being special.
6 years ago
Travis Ralston c94f3619b7 Missed a rogue case of identity server 6 years ago
Travis Ralston 7ac76fa27c Actually we're going with "identity server" afterall 6 years ago
Travis Ralston ec248b436f Identity Service is lowercase 6 years ago
Travis Ralston cc0badaaa1 Fix all naming cases of "identity service"
Fixes https://github.com/matrix-org/matrix-doc/issues/1396

Includes some "homeserver" fixes too. This commit does not include historical documentation or notes.
6 years ago
Richard van der Hoff c2ed79bd1a
Sentence case for headings 6 years ago
Richard van der Hoff 2605c75f92
typo 6 years ago
Richard van der Hoff c84066df89
do not use 'optional' in descriptions. 6 years ago
Richard van der Hoff dfa4af5c19
record that "identity server" has two words 6 years ago
Richard van der Hoff 3c7db643c3
Update documentation_style.rst
spell homeserver
7 years ago
Richard van der Hoff 196e668768
Update documentation_style.rst 7 years ago
Richard van der Hoff 0a917b2c70
documentation_style typo 7 years ago
Richard van der Hoff 1028ea3558
doc style: lists 7 years ago
Richard van der Hoff 3c40d5a94e
documentation_style: fix indentation 7 years ago
Richard van der Hoff 306783b7bf notes on doc style 7 years ago
Richard van der Hoff 91c1d9ed58
documentation_style.rst: Fix rst syntax
apparently the rst parser gets confused by '- `````'.
7 years ago
Richard van der Hoff b5d68b8ff1 Link to doc style doc
(and update it to cover extra section characters)
8 years ago
Kegsay 4fd5b9ced8 Update doc style
We use RST everywhere, which dictates most of the style, so the styles mentioned previously were either obsolete or inaccurate. Updated the doc to be clearer on things which RST does not specify/care about.
10 years ago
Matthew Hodgson 556e3f8a71 move matrix-generic documentation from synapse/docs into new matrix-doc project 10 years ago