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

Fix: main README.md overhaul #2019

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Conversation

dragonmux
Copy link
Member

@dragonmux dragonmux commented Dec 14, 2024

Detailed description

In this PR we address the state of the main project README, giving it an overhaul for the upcoming v2.0 release where a great many things about how the project is built and managed changes.

During this process we have also addressed descriptional issues with how the README introduces the project and its purpose, and updated the pills displayed to include more useful information.

Your checklist for this pull request

Closing issues

Fixes #1933 and #1937

@dragonmux dragonmux added Enhancement General project improvement Documentation Project documentation labels Dec 14, 2024
@dragonmux dragonmux added this to the v2.0 release milestone Dec 14, 2024
@dragonmux dragonmux requested a review from esden December 14, 2024 11:32
@dragonmux dragonmux force-pushed the fix/main-readme-overhaul branch from 7e19e82 to 5baf596 Compare December 14, 2024 12:00
README.md Outdated Show resolved Hide resolved
@dragonmux dragonmux force-pushed the fix/main-readme-overhaul branch 2 times, most recently from 4198668 to fac27e3 Compare December 16, 2024 06:05
@dragonmux dragonmux force-pushed the fix/main-readme-overhaul branch from fac27e3 to 05bbaa0 Compare December 16, 2024 08:10
@dragonmux dragonmux mentioned this pull request Dec 16, 2024
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Project documentation Enhancement General project improvement
Projects
None yet
2 participants