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

chore(docs): Update README #505

Open
EandrewJones opened this issue Oct 9, 2024 · 0 comments
Open

chore(docs): Update README #505

EandrewJones opened this issue Oct 9, 2024 · 0 comments
Labels
Documentation Instructional Material and Reference Good First Issue Stuff for folks new to project help wanted
Milestone
Enhance Developer...

Comments

@EandrewJones
Copy link
Contributor

Problem

Our README is stale, has broken links (ex: "What's New" in the TOC), and is not sufficient for newcomers to immediately get off the ground without running into issues.

Solution

  • Remove stale parts
  • Update links
  • Make link to CONTRIBUTING.md and who should go there obvious
@EandrewJones EandrewJones added help wanted Documentation Instructional Material and Reference Good First Issue Stuff for folks new to project labels Oct 9, 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 Instructional Material and Reference Good First Issue Stuff for folks new to project help wanted
Projects
None yet
Milestone
Enhance Developer Experience
Development

No branches or pull requests
1 participant
@EandrewJones