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.

Sign up for GitHub

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

Jump to bottom

[docs] Make Quickstart instructions more clear #3774

Merged
merged 4 commits into from
Jan 29, 2024
Merged

[docs] Make Quickstart instructions more clear #3774

merged 4 commits into from
Jan 29, 2024

Conversation

jackkoenig
Copy link
Contributor

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Documentation or website-related

Desired Merge Strategy

  • Squash

Release Notes

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.6.x, 5.x, or 6.x depending on impact, API modification or big change: 7.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

@jackkoenig jackkoenig added the Documentation Only changing documentation label Jan 29, 2024
mwachs5
mwachs5 approved these changes Jan 29, 2024
View reviewed changes
Copy link
Contributor

@mwachs5 mwachs5 left a comment

Choose a reason for hiding this comment

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

clearer for copy-pasters like me :)

mwachs5
mwachs5 reviewed Jan 29, 2024
View reviewed changes
docs/src/installation.md Outdated Show resolved Hide resolved
mwachs5
mwachs5 reviewed Jan 29, 2024
View reviewed changes
docs/src/installation.md Outdated Show resolved Hide resolved
mwachs5
mwachs5 reviewed Jan 29, 2024
View reviewed changes
docs/src/installation.md Outdated Show resolved Hide resolved
mwachs5
mwachs5 reviewed Jan 29, 2024
View reviewed changes
Copy link
Contributor

@mwachs5 mwachs5 left a comment

Choose a reason for hiding this comment

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

suggested some numberings to make the steps more divide, but either way this PR is more clear

@jackkoenig @mwachs5
Apply suggestions from code review
0ed49e9 
Co-authored-by: Megan Wachs <megan@sifive.com>
jackkoenig
jackkoenig commented Jan 29, 2024
View reviewed changes
docs/src/installation.md Outdated Show resolved Hide resolved
jackkoenig
jackkoenig commented Jan 29, 2024
View reviewed changes
docs/src/installation.md Outdated Show resolved Hide resolved
@jackkoenig jackkoenig enabled auto-merge (squash) January 29, 2024 18:48
@jackkoenig jackkoenig merged commit 866a8e3 into main Jan 29, 2024
14 checks passed
@jackkoenig jackkoenig deleted the jackkoenig/improve-quickstart branch January 29, 2024 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mwachs5 mwachs5 mwachs5 approved these changes

Assignees
No one assigned
Labels
Documentation Only changing documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jackkoenig @mwachs5