Repository navigation
/docs gets the methodology layout and a contents list - #2763
Merged
Merged
Conversation
It shipped as one column of prose and bullets, which is fine for a page
read top to bottom and wrong for this one: nobody reads an API index in
order, they arrive mid-task looking for one endpoint.
Same shell as /methodology now. The wider max-w-5xl, the large hero,
numbered Section I to VIII headers, and card-soft panels instead of
loose lists. The four MCP tools and the eleven endpoints are hover-ruled
definition rows, the same component /methodology uses for its
statistical conventions, which gives the endpoint path and its
description a stable two-column relationship instead of running them
together.
The contents list is the one thing /methodology does not have and this
page needs. Eight sections, each with an anchor, in a two-column card
under the hero. Section headers carry scroll-mt-24 so an anchor does not
land under the sticky header.
Two things improved while moving:
The Markdown section listed its five paths inline and mentioned the
exclusions in a trailing clause. The paths are chips now and the
exclusion is its own line, because "/rpc and /chains/{slug} are not among
these" is the sentence that saves someone an afternoon.
The citation section had the two Zenodo DOIs in one paragraph with the
index endpoints. They are different decisions. Which DOI you cite depends
on whether the reference should follow the dataset or freeze with your
result; which index endpoint you point at depends on whether the page
will move. Two cards, one each.
Every fact is unchanged and still the probed one.
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
4294bd3023b3ec54399f20a3b62d93161ee01976from dev (#2762). This commit only.Same shell as
/methodology: max-w-5xl, large hero, numbered Section I to VIII headers, card-soft panels. The four MCP tools and the eleven endpoints use the hover-ruled definition rows/methodologyuses for its statistical conventions.The contents list is the one thing
/methodologydoes not have and this page needs, since nobody reads an API index in order. Eight anchors,scroll-mt-24so they clear the sticky header.Verified: 8/8 anchors, 8/8 contents links resolve, one h1, tsc and eslint clean, 395 tests. Every fact unchanged.