TheOtherRoles icon indicating copy to clipboard operation
TheOtherRoles copied to clipboard

Split README

Open homeworkprod opened this issue 1 year ago • 0 comments

The README is quite long and unwieldy to navigate (and edit).

The list of releases could be moved to a separate file or completely be replaced by using GitHub's releases feature (which is already used by this project).

I suggest to extract the changelog into a separate file (CHANGELOG.md is one of the more common names, and the extension allows use of Markdown which GitHub renders) and link to it (so one can get there with a click in GitHub's presentation of the README).

More sections (installation, role descriptions, settings, …) could be extracted into separate files as well. Having especially the role descriptions in a separate file would make it easier to bookmark and to navigate in it (shorter scroll bar, no additional text that is found by searching in the page, rendering probably needs a little less resources).

Due to being able to link between those files, browsing the docs would work directly on GitHub.

homeworkprod avatar Sep 01 '22 23:09 homeworkprod