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

Update README.md and CONTRIBUTING.md #362

Merged
merged 2 commits into from
Jun 12, 2024

Conversation

xedmain
Copy link
Contributor

@xedmain xedmain commented Jun 12, 2024

  • 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
@xedmain xedmain requested a review from nullsystem June 12, 2024 03:17
Rainyan
Rainyan previously approved these changes Jun 12, 2024
@Rainyan
Copy link
Collaborator

Rainyan commented Jun 12, 2024

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:

toc

Alternatively could set up some GitHub action that rebuilds the ToC for changes to README.md in master.

@xedmain
Copy link
Contributor Author

xedmain commented Jun 12, 2024

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:

toc

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?

@Rainyan
Copy link
Collaborator

Rainyan commented Jun 12, 2024

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?

@nullsystem
Copy link
Collaborator

@Rainyan @xedmain I'm tempted to just say remove the manual listing and just direct people to use that button for table of content. Admittedly I didn't realize it's a thing but it's automatic and interactive. Also change it for CONTRIBUTING.md.

@Rainyan
Copy link
Collaborator

Rainyan commented Jun 12, 2024

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

@xedmain
Copy link
Contributor Author

xedmain commented Jun 12, 2024

Sure, should I also edit CONTRIBUTING.md as well?

@nullsystem
Copy link
Collaborator

Sure, should I also edit CONTRIBUTING.md as well?

@xedmain Yes

nullsystem
nullsystem previously approved these changes Jun 12, 2024
@xedmain xedmain dismissed stale reviews from nullsystem and Rainyan via 5d639e9 June 12, 2024 17:35
@xedmain
Copy link
Contributor Author

xedmain commented Jun 12, 2024

@Rainyan @nullsystem done

@xedmain xedmain changed the title Update README.md Update README.md and CONTRIBUTING.md Jun 12, 2024
Copy link
Collaborator

@Rainyan Rainyan left a comment

Choose a reason for hiding this comment

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

Thank you!

@xedmain xedmain merged commit 1217ce3 into NeotokyoRebuild:master Jun 12, 2024
Rainyan pushed a commit that referenced this pull request Jul 1, 2024
Update README.md and CONTRIBUTING.md
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.

None yet

3 participants