Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updating the getting started page #1659

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

annacasto
Copy link
Contributor

Describe your changes
Made some changes to the Getting Started section of index.md to increase readability and to create a list of documentation pages to get started on. I hoped this would give new users a place to find the most helpful documentation pages for going through the steps of installation, building a workflow, and running the workflow in parallel.

Type of update
Is this a:

  • Update to documentation

Associated issues
Reference associated issue numbers. Does this pull request close any issues?

Additional context

For the reviewer
See this page for instructions on how to review the pull request.

  • PR functionality reviewed in a Jupyter Notebook
  • All tests pass
  • Test coverage remains 100%
  • Documentation tested
  • New documentation pages added to plantcv/mkdocs.yml
  • Changes to function input/output signatures added to updating.md
  • Code reviewed
  • PR approved

@annacasto annacasto added documentation Documentation issues or features work in progress Mark work in progress labels Jan 21, 2025
@annacasto annacasto self-assigned this Jan 21, 2025
Copy link

deepsource-io bot commented Jan 21, 2025

Here's the code health analysis summary for commits c6105a7..fcbb56a. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Python LogoPython✅ SuccessView Check ↗
DeepSource Test coverage LogoTest coverage✅ SuccessView Check ↗

Code Coverage Report

MetricAggregatePython
Branch Coverage100%100%
Composite Coverage100%100%
Line Coverage100%100%

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

@nfahlgren nfahlgren added this to the PlantCV v4.7 milestone Jan 24, 2025
@HaleySchuhl HaleySchuhl requested a review from zeeuqsze January 24, 2025 16:43
@HaleySchuhl HaleySchuhl added ready to review and removed work in progress Mark work in progress labels Jan 24, 2025
Copy link
Contributor

@zeeuqsze zeeuqsze left a comment

Choose a reason for hiding this comment

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

Updates to Getting Started Page look good.
Only issue is "!!!tip", I think it is supposed to make a button or effect, but when I preview the markdown file, it just shows as "!!!tip" text. I think the markdown for making a Tip block is [!TIP]

@nfahlgren
Copy link
Member

I think these blocks are all supported: https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types

There needs to be a space between the !!! and the type: !!! tip

@annacasto annacasto requested a review from zeeuqsze February 19, 2025 07:30
@annacasto
Copy link
Contributor Author

Thanks! I fixed the space issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation issues or features ready to review
Projects
Status: Pull Requests
Development

Successfully merging this pull request may close these issues.

4 participants