doc: improve documentations#269
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures and expands LazySlide’s documentation, adding new “Getting started”, “Concepts”, “How-To”, and “Reference” sections while updating Sphinx configuration and developer tasks to support building the new docs layout.
Changes:
- Added new documentation sections/pages (Getting started, Concepts, How-To guides, Reference lookup pages) and updated the docs home page navigation.
- Added quick-reference pages (workflow cheat sheet, outputs/keys, readers & formats) and improved installation guidance.
- Updated Sphinx config and
taskipytasks for docs builds, plus a small API docstring clarification.
Reviewed changes
Copilot reviewed 32 out of 32 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/lazyslide/io/_annotation.py | Docstring update for supported annotation formats. |
| pyproject.toml | Adds a docs build task intended to refresh remote-mirrored content. |
| docs/source/tutorials/index.rst | Improves tutorials landing page and adds guidance/links. |
| docs/source/reference/workflow-cheatsheet.md | New cheat sheet mapping common goals to functions. |
| docs/source/reference/outputs.md | New reference for default output keys/locations. |
| docs/source/reference/index.md | New “Lookup guides” landing page for reference material. |
| docs/source/reference/formats.md | New page describing readers, formats, and annotation formats. |
| docs/source/installation.rst | Adds install verification steps; expands reader installation tabs. |
| docs/source/index.rst | Updates docs home page structure and navigation links. |
| docs/source/how-to/visualization.md | New visualization How-To guide. |
| docs/source/how-to/troubleshooting.md | New troubleshooting How-To guide. |
| docs/source/how-to/tissue-and-tiles.md | New tissue detection/tiling How-To guide. |
| docs/source/how-to/slides-and-storage.md | New slides/storage How-To guide. |
| docs/source/how-to/segmentation.md | New segmentation How-To guide. |
| docs/source/how-to/multiple-slides.md | New multiple slides/scaling How-To guide. |
| docs/source/how-to/models-and-features.md | New models/features How-To guide. |
| docs/source/how-to/installation.md | New How-To for environments/readers/HF access/offline. |
| docs/source/how-to/index.md | New How-To landing page with toctree + grid cards. |
| docs/source/how-to/annotations.md | New annotations How-To guide. |
| docs/source/how-to.md | Removes the previous single-page “How to?” document. |
| docs/source/glossary.rst | Expands glossary terms and definitions. |
| docs/source/getting-started/index.md | New getting-started landing page. |
| docs/source/getting-started/first-analysis.md | New first end-to-end analysis walkthrough. |
| docs/source/getting-started/digital-pathology-primer.md | New primer for WSI terminology and resolution concepts. |
| docs/source/conf.py | Adjusts autosummary warning suppression; gates remote content refresh. |
| docs/source/concepts/workflow.md | New workflow concept guide. |
| docs/source/concepts/resolution.md | New resolution/magnification/tiling concept guide. |
| docs/source/concepts/index.md | New concepts landing page with toctree + grid cards. |
| docs/source/concepts/data-model.md | New guide explaining WSIData storage and keys. |
| docs/source/concepts/choosing-models.md | New guide for model selection criteria. |
| docs/source/avail_models.md | Reorders model listing guidance and clarifies where to find generated lists. |
| docs/source/api/tools.rst | Adds tl.feature_prediction to the tools API listing. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Add/Update information for documentations