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

A few documentation changes... #556

Closed
6 tasks done
bmicklea opened this issue Oct 24, 2024 · 0 comments
Closed
6 tasks done

A few documentation changes... #556

bmicklea opened this issue Oct 24, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation epic

Comments

@bmicklea
Copy link
Contributor

bmicklea commented Oct 24, 2024 •
edited
Loading

Problems

Install Docs

  • Add brew instructions to installation docs
  • Clean up some of the unnecessarily repetitive headings and wording in installation docs

Readme

  • Update to reflect user feedback
  • Remove redundant parts and simplify some of the language

Quick Start

  • Rename and fix links

Other files

  • Fix minor wording issues
  • Improve clarity and conciseness

Linked PRs
@bmicklea bmicklea added documentation Improvements or additions to documentation epic labels Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation epic
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bmicklea