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

36 commits

Author SHA1 Message Date
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
David Robertson
f9ea0f9d9b
Only include endpoint path in <summary> (#1446) 2023-03-02 16:58:04 +00:00
Richard van der Hoff
a9e9202e89
Load Inter CSS directly (#1444) 
Move the load of the Inter font CSS from _variables_project.scss to head-end.html.

Empirically, this seems to fix #965
 2023-02-28 14:56:19 +00:00
Travis Ralston
029e988835 Matrix 1.6 2023-02-14 08:26:14 -07:00
Travis Ralston
5c485ade2e Prepare changelogs for v1.6 2023-02-07 11:58:31 -07:00
Kim Brose
d4586eba2e
Improve formatting of definitions in the Push Notifications section (#1415) 
Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
 2023-01-29 10:22:12 -05:00
dylhack.dev
f06ffc8176
replace "<content>" with "content" (#1370) 
* replace "<content>" with "content"

This parameter that's part of the content-repo openapi spec causes generators to mess up

* added changelogs

* Update changelogs/internal/newsfragments/1370.clarification

Co-authored-by: Travis Ralston <travpc@gmail.com>

Co-authored-by: Travis Ralston <travpc@gmail.com>
 2023-01-16 19:50:14 +00:00
Richard van der Hoff
7bd48ca9c7
Stop autogenerating examples where we already have one (#1384) 
If an object definition already has an example, we shouldn't try to extend that
definition by adding examples derived from the individual properties. Doing so
is confusing, and there is no way to inhibit it when it is not desired. It's
also not what the RapiDoc viewere does, so we end up with examples being
inconsistent.
 2022-12-21 16:24:11 +00:00
Travis Ralston
8a555fb411
Add some safety to the proposals script (#1368) 
* Add some safety to the proposals script

for if github's api explodes, forgets the header, or we are rate limited or something.

* changelog
 2022-12-08 12:41:55 -07:00
Johannes Becker
e481fd011a
Add link to the unstable spec to the README (#1357) 2022-11-24 11:09:05 +00:00
Travis Ralston
5f2fac89af Matrix 1.5 2022-11-17 08:22:20 -07:00
Richard van der Hoff
1e393fbf92
Improve error messages emitted by resolve-additional-types (#1303) 
I forgot to set the `items` on an array definition, and got an extremely
opaque error. Hopefully this will improve the lives of anyone who makes a
similar mistake in future.
 2022-11-17 07:23:12 +00:00
Andrew Morgan
cb2d5653ee
Add Event Replacements, Threading and Reference Relations modules to module summary table (#1344) 2022-11-17 00:07:04 +00:00
Andrew Morgan
b5005e64f7
Document that non-spec changes should get an 'internal' changelog entry (#1342) 2022-11-16 13:44:55 +00:00
Richard van der Hoff
f0246a5f12
Disable RSS for spec (#1346) 
This should really fix #1336
 2022-11-16 13:20:06 +00:00
Richard van der Hoff
3c9139bd5d
Unpack spec into right place for htmltest (#1338) 
Hopefully, fixes https://github.com/matrix-org/matrix-spec/issues/1336
 2022-11-15 23:30:17 +00:00
Richard van der Hoff
08fde5f257
Generate unstable changelogs using towncrier (#1340) 
Replace the current stack of hugo templates with a towncrier invocation. The main advantage of this is that it means that the "Changes since last release" section is consistent with the changelogs for the actual releases.

This also changes the release process so that the changelog is generated before tagging, which means that the thing tagged v1.5 is actually the v1.5 spec.

Fixes #908.
 2022-11-15 23:26:55 +00:00
Richard van der Hoff
bc15d4f9bc
Make definition anchors more unique (#1339) 
Stick a `definition-` on the front of the autogenerated anchors for definition
blocks.

This solves a problem where, for example,
https://spec.matrix.org/unstable/application-service-api/#registration could
refer to either the "Registration" section or the `Registration` definition
therein.

(These anchors are relatively recent: they were added in #1191.
 2022-11-15 19:15:34 +00:00
Kévin Commaille
b38cd08fbd
Add newsfragment 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2022-11-09 10:29:29 +01:00
Richard van der Hoff
8dd89e0510 changelog 2022-11-08 19:00:38 +00:00
Andrew Morgan
fd41d9d4ed
Update docsy (hugo theme) git submodule (#1295) 2022-11-08 17:29:10 +00:00
Richard van der Hoff
b07fe504ed
Stop rendering CS modules and room version fragments as standalone pages (#1317) 
This is actually doing two things:

 * creating `{fragments,modules}/index.md` turns the fragments and modules into
   page resources, rather than pages in their own right. We have to update the
   shortcodes to match.

 * adding `headless: true` means that we don't render the pages.

The net effect is that we don't render pages like
https://spec.matrix.org/v1.4/rooms/fragments/v1-auth-rules/ and
https://spec.matrix.org/v1.4/client-server-api/modules/account_data/.
 2022-11-08 17:27:44 +00:00
Alexandre Franke
39f79fe521
Update link to API viewer (#1308) 
* Update link to API viewer

Fixes #2
 2022-11-01 15:06:59 +00:00
Travis Ralston
7a591366c1 v1.4 changelog 2022-09-29 07:03:48 -06:00
David Robertson
a6990ff27c
Fix spacing of mapping types (#1230) 
* Fix spacing of mapping types

* Changelog
 2022-09-06 10:21:51 -06:00
Richard van der Hoff
1930824898
include CS-api modules with {{< (#1205) 
... because that fixes everything. Or at least, #1204.
 2022-08-10 10:44:38 +01:00
Richard van der Hoff
ef384f1afd
Give rendered-data sections a background and some padding (#1195) 
Gives definition sections for APIs, events, etc a background and a small indent, which I find very helpful to guide the eye.
 2022-08-04 09:46:11 +00:00
Richard van der Hoff
dc4fd9bdd6
Render HTML anchors for definition blocks (#1191) 
It's handy to be able to link to these.
 2022-08-03 07:28:47 +01:00
Travis Ralston
569e139ac5
Add an "internal changes" changelog section (#1194) 
* Add an "internal changes" changelog section

* update changelog number
 2022-08-02 19:48:35 -06:00