Repository navigation
Commit bd3e398
authored
* docs(http-server): link the docs site and move the detail into it
The README was 405 lines while the docs site was a 58-line scaffold --
inverted relative to the sibling packages, whose READMEs run 52-134 lines
with the substance on Read the Docs. It also had no link to the site,
which now exists.
Adds `Documentation: <https://zarr-http-server.readthedocs.io/>` at the
top, matching where zarr-metadata and zarr-indexing put theirs, and moves
the detailed sections into a new docs/guide.md: building apps, running
them, several nodes, notebooks, Uvicorn configuration, CORS, byte ranges,
read-only serving, writes and shutdown. The README keeps what a reader
skimming PyPI needs -- what it is, install, a quick start, the build/run
split, and the warning that store_app filters nothing.
Fixes found while reviewing rather than moved verbatim:
- docs/index.md paired store_app with serve and node_app with
serve_background as though they were coupled. They are independent;
either app runs under either runner.
- docs/index.md sent readers to the README for worked examples, which is
backwards now and would have been a loop.
- The range section cited RFC 7233, obsoleted by RFC 9110, while the rest
of the same section cited 9110.
- Write examples used a bare `methods={"GET", "PUT"}` although the
read-only section a few paragraphs earlier introduced
READ_WRITE_HTTP_METHODS for exactly that.
- "Read-only serving" and "Write support" restated each other; merged.
- The API reference documented 8 of the 13 public names. Added
ReadOnlyHTTPMethod, READ_ONLY_HTTP_METHODS, READ_WRITE_HTTP_METHODS,
AUTO_PORT and DEFAULT_PORT -- the missing ReadOnlyHTTPMethod was also
breaking a cross-reference from the new guide.
Deep links use /en/latest/ rather than /en/stable/: verified to resolve,
and it picks up this change as soon as the site rebuilds. (zarr-metadata's
README links /en/stable/, which currently 404s.)
Assisted-by: ClaudeCode:claude-opus-5
* docs: fix dead links in the subpackage READMEs
Two broken links found by checking every URL in all three packages'
READMEs and docs rather than only the one being edited.
zarr-metadata's `Documentation:` link pointed at
readthedocs.io/en/stable/, which 404s -- neither it nor zarr-indexing has
a `stable` version. Dropped the version segment so it matches the other
two and lets Read the Docs redirect to whatever the default is.
`www.uvicorn.org` no longer resolves at all: the domain is gone, not
merely moved, so it fails DNS rather than returning a 404. Uvicorn's own
PyPI metadata now gives `https://uvicorn.dev/` as its homepage. Fixed in
the zarr-http-server README and docs index, the only two places it
appeared.
Every other link in the three READMEs and their docs trees resolves. The
two remaining 404s are this PR's own links to the not-yet-published
guide page, which resolve once the site rebuilds.
Assisted-by: ClaudeCode:claude-opus-5
1 parent 5b9c09f commit bd3e398
6 files changed
Lines changed: 474 additions & 391 deletions
0 commit comments