Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi,
I've gone and moved the documentation from the wiki over to Mkdocs using GitHub pages. I've amalgamated a good chunk of the documentation both from what is in the wiki, the README, and what was also in the code and not present in both (i.e. pausing/freezing players during vetoes, pause events, etc.).
In order for this to work, the new GitHub action will create a new branch called
gh-pages
which can be seen here. It compiles all the markdown pages located in the new documentation directory and creates a nice website to with the material theme to navigate through. I figured it may be easier to move documentation to a more maintainable solution (per #586), where anyone can edit the documentation.Right now, the only pages I have omitted are the following:
I can also reinstate these pages as well, if you'd like, but I figured I would try and keep the documentation closer to "usage of this plugin" instead of "other things that you can do in conjunction with this plugin".
Oh, and I've also updated the example match JSON to include the latest map pools since that was skipped, updated the workflow for the build to allow for one multi-line run instead of 20 lines of
run:
, and updated the README to point to the new docs site once it gets enabled.The only thing that would need to be done if this gets merged is to go to Settings -> Pages and enable the source on the
gh-pages
branch once built.Once complete, you will be able to see the documentation website, like you can see here as an example..
One possible TODO before this goes in as well, would be to create a PR template that has some acknowledgement boxes such as "I have updated the documentation if there were any new changes". For example, if someone creates a new Event or config option, they will have to include it in the events documentation, so it doesn't get lost in code. If all looks good, we can take this out of draft and merge it in.
Thanks!