Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the project documentation for better clarity, adds a new IO API entry, refines workflow steps, and adjusts the docs build trigger.
- Refines the package description and fixes tutorial link entries
- Adds
io.adata_to_voronoito the API docs - Expands and renumbers the workflow components list
- Extends the GitHub Actions docs workflow to run on the
docsbranch
Reviewed Changes
Copilot reviewed 4 out of 14 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/index.md | Updated project intro wording; adjusted tutorial link paths and toctree entries |
| docs/api/io.md | Added io.adata_to_voronoi to the IO toctree |
| docs/Workflows/index.md | Expanded workflow steps from 4 to 7 and renumbered list items |
| .github/workflows/docs.yml | Added docs branch trigger for the documentation build |
Comments suppressed due to low confidence (3)
docs/api/io.md:12
- You added
io.adata_to_voronoito the toctree, but there isn't a corresponding generated doc file. Ensure the.md(or.rst) exists or regenerate the API docs.
io.adata_to_voronoi
docs/index.md:66
- The link uses 'Tutorials/...' (uppercase), but the directory is likely named 'tutorials'. Please confirm the correct casing to avoid broken links.
- [Tutorial 1: Image analysis](Tutorials/T1_ImageAnalysis)
docs/index.md:84
- The toctree entry uses 'Tutorials/index' (uppercase), but the folder may be lowercase 'tutorials'. Verify the path casing so the build includes the correct files.
Tutorials/index
| 3. Image analysis | ||
| 4. Sampling strategy | ||
| 5. Sample collection | ||
| 6. Sample prepatation and LCMS |
There was a problem hiding this comment.
Typo: 'prepatation' should be 'preparation'.
Suggested change
| 6. Sample prepatation and LCMS | |
| 6. Sample preparation and LCMS |
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.
No description provided.