-
Notifications
You must be signed in to change notification settings - Fork 267
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
Conversation
Here's the code health analysis summary for commits Analysis Summary
Code Coverage Report
|
There was a problem hiding this 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]
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 |
Thanks! I fixed the space issue. |
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:
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.
plantcv/mkdocs.yml
updating.md