wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
6679 commits 4 branches 0 tags 17 MiB
Commit graph

78 commits

Author SHA1 Message Date
Kévin Commaille
2678370f2c
Simplify uses of resolve-refs partial (#1773) 
* Use the resolve-refs partial as soon as possible

Call it right after accessing the site.Data,
since it is recursing it will solve all references in the tree.
That way we don't need to wonder where to call it,
we trust the validators that the refs will be used in the right place.

* Enable strict $ref rule in OpenAPI validator

* Document use of $ref to compose examples

* Fix schema path in event-fields shortcode

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-04-09 18:06:53 +01:00
Johannes Marbach
ee1a169121
Arrange rows in .basic-info tables vertically when horizontal space is constrained (#1771) 
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
 2024-04-09 13:31:46 +00:00
Kévin Commaille
e74c7c1540
Fix Hugo warnings (#1775) 2024-04-09 14:18:16 +01:00
Johannes Marbach
8ff3623e37
Reduce whitespace on mobile viewports (#1770) 
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
 2024-03-27 09:55:01 +00:00
Richard van der Hoff
c25ff9e012
Formatting fixes in CONTRIBUTING.rst (#1769) 
* Formatting fix in CONTRIBUTING.rst

* Fix link

* Create 1769.clarification
 2024-03-26 11:28:31 +00:00
Michael Telatynski
083e6ef25d
Fix npm publishing being broken in CI (#1765) 
* Fix `v` tag_name prefix sneaking into npm version

* Fix `yarn version` failing in CI due to no git global ident name

* Add changelog

* Rename 1765.misc to 1765.clarification
 2024-03-22 18:27:42 +00:00
Travis Ralston
f7452e2bad Matrix 1.10 2024-03-22 10:00:27 -06:00
Kévin Commaille
6700f5ddd1
Disable smooth scrolling (#1762) 
It was not enabled before the docsy update and it messes with
the TOC highlighting during the transition.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-03-21 11:03:07 +00:00
Travis Ralston
15663d405e Changelog normalization for Matrix 1.10 2024-03-19 15:47:06 -06:00
Kévin Commaille
575c84d431
Fix event-group shortcode for changes in resolve-refs partial (#1754) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-03-19 19:02:13 +00:00
David Baker
bb4003afa8
Factor out all the common parameters of the various /relations apis (#1745) 
Contributed by @zecakeh bd54781052.

Co-authored-by: Richard van der Hoff <richard@matrix.org>
 2024-03-19 17:03:44 +00:00
Kévin Commaille
4d7e33ec26
Add support for $ref URIs containing fragments in OpenAPI definitions and JSON schemas (#1751) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-03-19 14:50:49 +00:00
Hubert Chathi
0b43b5a343
Add some clarifications around implementation requirements for MSCs (#1718) 
* clarification around implementation requirement, and mention new label

* add changelog

* fix typo

* Fix typos

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>
 2024-03-13 11:28:30 -04:00
Richard van der Hoff
976ebdca2f
Update HTML templates to link to object definitions (#1724) 2024-02-28 10:39:08 +00:00
Kévin Commaille
b136b357e0
Update docsy to v0.8.0 (#1699) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-02-27 18:12:39 +00:00
Michael Telatynski
650e691a22
Fix npm release script (#1713) 
* Fix npm release script

* Create 1713.misc
 2024-01-17 10:16:28 -07:00
Richard van der Hoff
4a80df364a
Wording tweak in CONTRIBUTING.rst (#1697) 2023-12-21 18:13:26 +00:00
Travis Ralston
59f8d632a3
Add step to release process to remind ourselves to reach out to Advocacy (#1680) 
* Add step to release process to remind ourselves to reach out to Advocacy

* changelog
 2023-11-29 10:59:23 -07:00
Travis Ralston
0c099e3b79 Matrix 1.9 2023-11-29 10:05:20 -07:00
Travis Ralston
634b24fb25 Normalize changelog for 1.9 2023-11-27 15:58:06 -07:00
Kévin Commaille
560d98ba9b
Add more CI checks for OpenAPI definitions and JSON Schemas (#1656) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2023-10-11 10:36:39 +00:00
Kévin Commaille
c71b528148
Upgrade GitHub actions (#1660) 
* Upgrade most github actions

Gets rid of warning in CI complaining about those actions
using node 12.

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

* Upgrade node version used to run scripts

Use the latest LTS

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

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2023-10-11 11:23:16 +01:00
Kévin Commaille
72517c0f9c
Generate server-server OpenAPI definition (#1657) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2023-10-10 18:21:38 +01:00
Kévin Commaille
e40d9ca186
Fix rendering of m.receipt event in Client-Server API (#1637) 
... and other improvements

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2023-09-27 12:42:14 +00:00
Kévin Commaille
5672bdbab7
Fix enum types in JSON schemas (#1634) 
`type: enum` does not exist, as an enum can be of any type.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2023-09-27 13:29:14 +01:00
Michael Telatynski
f11c5600a2
Fix npm package release automation (#1648) 2023-09-26 18:08:02 +00:00
Kévin Commaille
99e2ff4927
Replace all mentions of Swagger by OpenAPI (#1633) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2023-09-19 18:26:07 +01:00
Kévin Commaille
df3f0af5d4
Fix schema of m.mentions object (#1635) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2023-09-19 16:59:00 +01:00
Travis Ralston
529cbf4ffc Matrix 1.8 changelog 2023-08-23 09:24:08 -06:00
Travis Ralston
06298e4d8d Normalize changelog for Matrix 1.8 
See https://github.com/matrix-org/matrix-spec/issues/1614
 2023-08-22 10:05:28 -06:00
Michael Telatynski
c0babbfc13
Create @matrix-org/spec npm package containing sas-emoji.json (#1620) 
* Create packages/npm @matrix-org/spec npm package containing spec-emoji

* Initial workflow script

* Add newsfragment

* Add docs

* npm publish doesn't like symlinks, yarn does :((
 2023-08-18 09:56:55 -06:00
Richard van der Hoff
f5035b8e02
Fix up attribution 
Per request at https://github.com/matrix-org/matrix-spec/pull/1601#discussion_r1269035798
 2023-07-20 08:44:56 +01:00
Martin Fischer
1a11a7b998
Use auto table-layout on desktop (#1601) 
Signed-off-by: Martin Fischer <martin@push-f.com>
 2023-07-20 07:23:16 +00:00
Kévin Commaille
639caf057d
Fix rendered changelog with new version of towncrier (#1598) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2023-07-18 17:52:38 +01:00
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>
 2023-06-28 08:11:28 -06:00
Richard van der Hoff
b2ab339ba6
Bump hugo version used for the build (#1591) 
Since https://github.com/matrix-org/matrix-spec/issues/1544 is fixed, we can
use a modern hugo.
 2023-06-28 07:26:14 +01:00
Kévin Commaille
a6eb381ebb
Fix the sidebar in recent versions of Hugo (#1551) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2023-06-27 22:24:22 +01:00
Kévin Commaille
4a9bda9bed
Use tag name as the OpenAPI definition version (#1561) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2023-06-20 18:20:22 +01:00
Kévin Commaille
adff3faa35
Make sure version in x-changedInMatrixVersion is a string (#1562) 2023-06-10 14:44:06 +03:00
Kévin Commaille
3c5355a278
Use Redocly CLI to validate OpenAPI definitions (#1558) 2023-06-09 21:55:12 +03:00
Kévin Commaille
f4aa7c0327
Bump the version of jsonschema (#1556) 
* Bump the version of jsonschema

OpenAPI 3.1 uses JSON Schema Draft 2020-12 so we need a version that
supports it.

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

* Add changelog

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

* Fix PR number

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

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2023-06-07 12:36:47 -06:00
Kévin Commaille
45b6aaf07a
Upgrade Swagger data to OpenAPI 3.1 (#1310) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2023-06-07 13:16:29 +01:00
Andrew Morgan
c64a616d54
Update the changelog entry checker script to check newsfragment file extension (#1542) 2023-05-31 11:30:51 +01:00
David Robertson
48459dee9b
Only include titles in summaries (#1549) 
I previously made this change for HTTP endpoints in #1446. It seems there are
other places where we have over-sized `<summary>` elements. I would like
to elimintate those too, as grumbled about in
https://github.com/matrix-org/matrix-spec/issues/1358#issuecomment-1325220859
and
https://github.com/matrix-org/matrix-spec/issues/1352#issuecomment-1439033334
 2023-05-30 13:22:30 +01:00
Travis Ralston
8b51f1c011 Matrix 1.7 2023-05-25 09:47:33 -06:00
Travis Ralston
fbb8a789f6
Add release checklist issue template; Document some of our timelines around releases (#1538) 
* Add a spec release checklist issue template

because I'm tired of copy/paste

* Document a chunk of our release approach

This should probably go elsewhere, but here is fine for now as a SCT-referenced doc/content.

* changelog

* Brief clarifications
 2023-05-25 09:35:38 -06:00
Travis Ralston
d028dc4b82 Normalize changelog for v1.7 2023-05-23 16:19:09 -06:00
Michael Kohler
17ebdf7c86
Fix ASCII art alignment (#1534) 
* Fix ASCII art alignment

Signed-off-by: Michael Kohler <me@michaelkohler.info>

Fixes #1430

* Add changelog

---------

Co-authored-by: Travis Ralston <travpc@gmail.com>
 2023-05-23 18:28:46 +00:00
Richard van der Hoff
c662976fab
Fix generation of anchors for additional properties (#1488) 
but objects defined under `additionalProperties` missed out on them. This fixes
that.
 2023-05-02 11:41:59 +01:00
Richard van der Hoff
ac8d34bc81
Cleanups to github actions workflow (#1476) 2023-03-29 11:16:52 +01:00