search

NeotokyoRebuild / neo

NEOTOKYO Rebuild - Source SDK 2013 mod of NEOTOKYO
Other
11 stars 9 forks source link

Update README.md and CONTRIBUTING.md #362

Closed xedmain closed 1 month ago

xedmain commented 1 month ago
Rainyan commented 1 month ago

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 commented 1 month ago

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 commented 1 month ago

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 commented 1 month ago

@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 commented 1 month ago

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 commented 1 month ago

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

nullsystem commented 1 month ago

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

@xedmain Yes

xedmain commented 1 month ago

@Rainyan @nullsystem done