640 readme cleanup

[kyhu65867]

Committer Notes

{Please provide a description of what this PR accomplishes. Be sure to reference any issues addressed. If the PR is a work-in-progress submitted for early review, please submit the PR as a draft PR using the "Draft pull request" dropdown.}

All Submissions:

• Have you selected the correct base branch per Contributing guidance?
• Have you set "Allow edits and access to secrets by maintainers"?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?
• Have you squashed any non-relevant commits and commit messages? [instructions]
• Have you added an explanation of what your changes do and why you'd like us to include them?
• If applicable, have all FedRAMP Documents Related to OSCAL Adoption affected by the changes in this issue have been updated.?
• If applicable, does this PR reference the issue it addresses and explain how it addresses the issue?

By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.

[aj-stein-gsa]

@kyhu65867 thanks for the time today and pushing up the work, I will review once you have finished more of the work and mark it as ready for review from us. 😄

[kyhu65867]

I addressed most of issue 640 and some of issue 739. Still in progress but I think it's a significant improvement from where it was before

[kyhu65867]

I think the main readme is in a good place. I'm going to un-draft this, please let me know what you think!

[aj-stein-gsa]

And a general question, are we going to move the constraint README for development here and delete those files? Is this PR part of a series of such improvements or this going to be the end of this work?

(Sorry, typed this review question, but had not submitted. It's a few hours old.)

[kyhu65867]

I didn't know if we wanted to move the constraints readme just because I wanted this readme to be a general overview of everything this repo has and I think in its final form the repo will have more than just the constraints tooling (unless I'm wrong). I also could see this becoming a series of improvements, especially since there are a bunch of dead readme files scattered throughout the repo. But I think that is a part of a bigger project of "decluttering" so that we can have as streamlined and clear of a readme as possible. It's hard to make a streamlined and clear readme with sort of a clunky repo (no offense)

[brian-ruf]

[deleted my own erroneous review]

I thought I was approving one change, not the whole PR.

[aj-stein-gsa]

Some more changes and recommendations. There is a lot. We can talk through it later if you like.

[aj-stein-gsa]

Some minor touchups before a more thorough review. Also it looks like we need to rebase your branch as a bunch of constraint file changes are in the PR now that are not related to the README edits. That happens.

We are very close!