Repository navigation
a docs page, so the Docs group in the nav finally has one - #2758
Merged
Merged
Conversation
* a docs page, so the Docs group in the nav finally has one
The left rail had a group labelled Docs holding Methodology, API & MCP,
Contribute, About and Contact. There was no page that said what this
site exposes to a machine, so the answer was spread across /mcp, the
OpenAPI document, llms.txt and whatever a reader happened to find.
/docs is that index. The MCP server and its four tools, the eleven REST
endpoints the OpenAPI document declares, the paths that answer
Accept: text/markdown, the files written for agents, the four citation
formats, the badges, the feeds, and the same data on Hugging Face.
It does not repeat /mcp. That page is the install flow for Claude
Desktop, Cursor and VS Code with the deeplinks and the JSON blocks; this
one says what the server is and links there.
Nothing here was written from memory. Every endpoint, transport, format
and path was probed against production while the page was written:
- the four tools come from tools/list on the live server, not from the
route source
- the eleven endpoints are the ones /api/openapi.json declares, each
probed, including /api/og/{slug}, which is served through a rewrite
and so does not appear as a route file
- the citation formats are bib, ris, apa and txt. Not bibtex, which
answers 400 with the allowed list
- Markdown is served for /benchmarks/{slug}, /products/{slug}, /perps,
/rwa and /capital, and the page says so rather than implying every
page, because /rpc and /chains/{slug} answer HTML whatever the Accept
header asks for
- the MCP rate limit is rateLimit(key, 60, 60), which is 60 a minute
- both Zenodo DOIs are named and distinguished, because the record at
...312 declares ...311 as its conceptdoi and the two are not
interchangeable: the concept DOI follows the newest version, the
version DOI is the one that keeps a result reproducible
The two facts most likely to rot say where the live truth is: tools/list
for the tools, and the OpenAPI document for the endpoints, which is
generated from the routes rather than hand-written.
* docs: /api/citable goes through Link, like the footer already does
next/no-html-link-for-pages resolves /api/citable/ as a known route
because /api/citable/[date] exists next to it, so the bare <a> was an
error rather than a warning. The footer has used <Link> for the /api
surfaces since it was written; this matches it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Cherry-pick of
ecc3396afromdev(#2757). This commit only —devcarries 16 others that stay there./docsindexes every machine-readable surface: the MCP server and its four tools, the eleven REST endpoints, the paths that answerAccept: text/markdown, the agent files, the four citation formats, badges, feeds, and the same data on Hugging Face. It does not repeat/mcp, which is the install flow.Nothing was written from memory. The tools come from
tools/liston the live server, the endpoints from/api/openapi.json(each probed, including/api/og/{slug}which is served through a rewrite), the formats verified for status and MIME (bibtexanswers 400,bibis correct), the Markdown paths checked individually so the page can say/rpcand/chains/{slug}are not among them, the rate limit read offrateLimit(key, 60, 60), and both Zenodo DOIs distinguished using Zenodo's own API, which reports…312carryingconceptdoi: …311.All 59 URLs the rendered page shows were then probed. No broken links.
Verified after the pick:
tsc --noEmitclean, eslint clean on the new file, diff againstorigin/mainis exactly the 3 files.