Skip to content

updated docs#56

Merged
josenimo merged 5 commits intomainfrom
docs
Jul 7, 2025
Merged

updated docs#56
josenimo merged 5 commits intomainfrom
docs

Conversation

@josenimo
Copy link
Member

@josenimo josenimo commented Jul 7, 2025

No description provided.

@josenimo josenimo requested a review from Copilot July 7, 2025 08:22
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_voronoi to the API docs
  • Expands and renumbers the workflow components list
  • Extends the GitHub Actions docs workflow to run on the docs branch

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_voronoi to 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
Copy link

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: 'prepatation' should be 'preparation'.

Suggested change
6. Sample prepatation and LCMS
6. Sample preparation and LCMS

Copilot uses AI. Check for mistakes.
@josenimo josenimo merged commit 4a5871e into main Jul 7, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants