Rebuild the documentation on Zensical - #214
Merged
Merged
Conversation
lorenzocerrone
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ngio is an acronym: n(ext) g(eneration file format) IO, after the OME-NGFF specification the library reads and writes. The site title expands it again, while the descriptive "a Python library for OME-Zarr bioimage analysis" moves to the site description and the landing-page, README and llms.txt openers. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The rewritten opener led with second-person imperatives ("Open an image, reach
for the resolution level you need"), a register that belongs to task pages
rather than to a project's front door — zarr, napari, anndata, spatialdata and
scikit-image all open with "X is a Y that does Z". Restore that form, tightened
to drop the "mission is to streamline" and "comprehensive support" framing.
Also drop the sentence explaining where the name comes from (the title already
carries the acronym) and the changelog entry for the title, which reverted to
what main already had.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
1 participant
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.
Full refactor of the documentation site.
Summary
docs/snippets/, included viapymdownx.snippetsand run at build time. The five tutorial notebooks become Markdown pages, and CI builds with--strict(a plain build exits 0 even when a code block raised).docs/stylesheets/ngio.css, and six explanatory figures authored as inline SVG so they follow the light/dark toggle.CODE_OF_CONDUCT.mdandCITATION.cff, and moveCONTRIBUTING.mdto the repository root, single-sourced into the docs.site_url, tables rendering as literal|---|, and per-page snippet state under Zensical's fresh per-pagemarkdown-execsessions.Checklist before merging
CHANGELOG.md