Skip to content

Streamline the README #717

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.

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

Merged
merged 1 commit into from
Jun 12, 2025
Merged

Streamline the README #717

merged 1 commit into from
Jun 12, 2025

Conversation

danbarr
Copy link
Collaborator

@danbarr danbarr commented Jun 11, 2025

Now that we have the full docs site available, we don't need a super-long readme with detailed docs and scenarios.

This streamlines the main project README down to a concise value statement, a short-short version of the Quickstart, and some newly polished high-level diagrams.

Also filled out the docs section in CONTRIBUTING.md.

@danbarr danbarr marked this pull request as draft June 11, 2025 21:30
@danbarr danbarr marked this pull request as ready for review June 11, 2025 22:48
Copy link
Member

@rdimitrov rdimitrov left a comment

Choose a reason for hiding this comment

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

🚀

@rdimitrov rdimitrov merged commit 70a33b6 into main Jun 12, 2025
13 checks passed
@rdimitrov rdimitrov deleted the simpify-readme branch June 12, 2025 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants