apache
chore(docs): Update README
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 I would like to work on this issue. It'd be great if you can brief a bit more and assign this issue to me
@krishna-dave206 You can absolutely pick this up.
The first step is to attempt to follow the steps for setting up and using the project based on the README as is. Anywhere the directions are unclear or things do not work as written, we know that's a place we need to improve the documentation. Flag these and share here, so we can iterate with you to improve the docs.
A secondary step, after we iterate through the above improvements, is to go through the existing README and test to see which links are broken (i.e. point to non-existent external websites or other sections of the README). Remove these or flag them and we can tell you whether there's a new, correct resource to point to. I'll try to find some time to make a pass and identify specific things I know are broken.
Finally, we have a new CONTRIBUTING.md with much better guidelines about how to contribute to the project, but that's not well-reflected in the README. We should update the existing contributing section to point directly to our CONTRIBUTING.md.