Commit Graph

10 Commits (715e66fa00a6fa4e90ef1d55185fe9648527bdda)

Author SHA1 Message Date
Andrew Morgan f30e850bf1 Fix duplicate modules endpoints
I was seeing duplicate endpoints appearing under each module (typically
2 of each). This turned out to be due to the `render-operation` partial
being called multiple times (once when rendering the page, and another
when rendering the left-hand-side TOC).

We now check whether the endpoint has already been added to the list
before insertion, via a "seen" map (for quick lookup).
1 month ago
Andrew Morgan 468fcb3992 Group endpoints by module
Makes the list of endpoints easier to scan.
2 months ago
Andrew Morgan 2d0e4ea471 Source endpoints from CS API modules as well
Any endpoint in a CS API module was not getting listed. This is because they are stored in nested pages. We need to hoist them up to the outer page, such that they can be retrieved and rendered by our endpoints TOC partial.
2 months ago
Andrew Morgan 17acd978a4 Display "(deprecated)" next to deprecated endpoints 2 months ago
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.
2 months ago
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.
2 months ago
Andrew Morgan 56d48eb3a8 Add an endpoints table of contents
A simple list of endpoints that one can ctrl-f through.
2 months ago
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.
2 months ago
Johannes Marbach a5afe542c0
Add version picker in the navbar (#2256)
Co-authored-by: Andrew Morgan <andrew@amorgan.xyz>
2 months ago
Kévin Commaille 4d4069166d
Upgrade docsy to 0.12.0 (#2160) 5 months ago