-
Notifications
You must be signed in to change notification settings - Fork 9
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
Update README.md and CONTRIBUTING.md #362
Conversation
xedmain
commented
Jun 12, 2024
•
edited
Loading
edited
- Added server instructions for linux server ops
- Additional corrections/edits
- Removed TOC in README.md and CONTRIBUTING.md because there's a button for that on GitHub
- Added server instructions for linux server ops - Additional corrections/edits
This makes the README table of contents somewhat outdated though. But I'm not sure if we wanna keep maintaining that listing by hand, as it seems the new GitHub web UI has a "Headings" tool in the top-right hamburger menu already, making it somewhat redundant: Alternatively could set up some GitHub action that rebuilds the ToC for changes to README.md in master. |
I could manually edit the ToC if needed, but I decided that there would be too many subheadings or sth imo, would you want it to have subheadings for Server Ops and Testers/Devs? |
I'm ok with keeping the current headings as-is for now. @nullsystem do you have any opinions on this? |
Yeah, I have to agree we should probably get rid of the handwritten table of contents entirely, for maintainability sake. Could perhaps sneak that change in this PR @xedmain |
Sure, should I also edit CONTRIBUTING.md as well? |
@xedmain Yes |
@Rainyan @nullsystem done |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
Update README.md and CONTRIBUTING.md