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.

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

Massively simplify README by linking to new doc website #2131

Closed
wants to merge 1 commit into from

Conversation

ValueRaider
Copy link
Collaborator

With the new doc website online, the README can be massively reduced, bringing its structure inline with other popular packages.

@ericpien @ranaroussi

@ericpien
Copy link
Contributor

If we are planning on triggering the action on push to main in the future, dev-documented already has simplified README that can we can merge into main after changing the on-push-branches to include main. Do you want to target that instead for the PR?

@ValueRaider
Copy link
Collaborator Author

dev-documented already has simplified README

I missed this.

dev-documented will merge into dev first, then into main for a release.

@ValueRaider ValueRaider deleted the readme-simplify branch November 16, 2024 23:16
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