Commit graph

7 commits

Author SHA1 Message Date
Andrew Morgan 17acd978a4 Display "(deprecated)" next to deprecated endpoints 2025-12-05 15:48:20 +00:00
Andrew Morgan 1213f81676 Move each spec's intro above the endpoints list
This just looks visually nicer. You have an introduction paragraph, then
the list of endpoints, then the spec.
2025-12-05 15:47:08 +00:00
Andrew Morgan f03730455d Place the endpoints list just under the description of each API
We needed to override Docsy's default page renderers to show it. Because
the Client-Server API uses a different render chain than the other
endpoint pages, we have to override two of Docsy's pages (`content.html` and `single.html`).

In order to reduce duplication, we then put the shared content into a
`spec-content.html` partial.
2025-12-05 15:46:16 +00:00
Andrew Morgan 56d48eb3a8 Add an endpoints table of contents
A simple list of endpoints that one can ctrl-f through.
2025-12-05 15:12:15 +00:00
Andrew Morgan 82a67a1fab Store each endpoint's metadata in a slice on Page
Such that we can later construct the table of contents with the data.
2025-12-05 15:11:17 +00:00
Johannes Marbach a5afe542c0
Add version picker in the navbar (#2256)
Some checks are pending
Spec / 🔎 Validate OpenAPI specifications (push) Waiting to run
Spec / 🔎 Check Event schema examples (push) Waiting to run
Spec / 🔎 Check OpenAPI definitions examples (push) Waiting to run
Spec / 🔎 Check JSON Schemas inline examples (push) Waiting to run
Spec / ⚙️ Calculate baseURL for later jobs (push) Waiting to run
Spec / 🐍 Build OpenAPI definitions (push) Blocked by required conditions
Spec / 📢 Run towncrier for changelog (push) Waiting to run
Spec / 📖 Build the spec (push) Blocked by required conditions
Spec / 🔎 Validate generated HTML (push) Blocked by required conditions
Spec / 📖 Build the historical backup spec (push) Blocked by required conditions
Spell Check / Spell Check with Typos (push) Waiting to run
Co-authored-by: Andrew Morgan <andrew@amorgan.xyz>
2025-12-04 12:24:28 +00:00
Kévin Commaille 4d4069166d
Upgrade docsy to 0.12.0 (#2160) 2025-08-27 07:35:57 +01:00