[GitHub Action] Update docs

return-of-modding · Dec 12, 2023 · c329957 · c329957
1 parent 6ac5a59
commit c329957
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 0 deletions.
diff --git a/docs/Resources/Sprites.md b/docs/Resources/Sprites.md
@@ -0,0 +1,15 @@
+Sprites from the game to download and use them with your program of choice. (thank you to k king for passing me the sprites, and doodle/oodl for the items)
+
+[Acrid.rar](https://github.com/return-of-modding/ModdingWiki/raw/main/Media/Sprites/Acrid.rar)
+
+[Artificer.rar](https://github.com/return-of-modding/ModdingWiki/raw/main/Media/Sprites/Artificer.rar)
+
+[Bandit.rar](https://github.com/return-of-modding/ModdingWiki/blob/main/Media/Sprites/Bandit.rar)
+
+[CSS.rar](https://github.com/return-of-modding/ModdingWiki/raw/main/Media/Sprites/CSS.rar)
+
+[Sprites.rar](https://github.com/return-of-modding/ModdingWiki/raw/main/Media/Sprites/Sprites.rar)
+
+[Sprites (continued).rar](https://github.com/return-of-modding/ModdingWiki/raw/main/Media/Sprites/Sprites%20(continued).rar)
+
+[items.rar](https://github.com/return-of-modding/ModdingWiki/blob/main/Media/Sprites/items.rar)
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,34 @@
+# Welcome to the Risk of Rain Returns Modding Wiki !
+
+This place serves as a center for guides related to Risk of Rain Returns Modding.
+
+These guides help to teach concepts and should prove as a useful resource to modders.
+
+Please feel free to contribute to anything you think should be improved !
+
+But before that, please read the paragraph below on how to contribute correctly.
+
+## Contributing
+
+Anyone can edit this wiki, as long as you have a GitHub account.
+
+### Creating a new page
+Please head to this [link](https://github.com/return-of-modding/ModdingWiki/wiki/_new) and format the title of your page as follow:
+
+`Required-Category_Optional-Sub-Category_Page-Name`
+
+You should **always** put a category for your page!
+
+Here is how the page named `FirstFolder_This-is-folder2_This-is-the-file-name` looks in the sidebar once it gets added to the generated github pages website.
+
+![New Page in the sidebar](https://i.imgur.com/cmjca6E.png)
+
+Note: The [GitHub Pages Website](https://return-of-modding.github.io/ModdingWiki) only gets updated every 24 hours! If you think your awesome contribution really needs to be available asap on the website, please ask the maintainers in the [modding discord](https://discord.gg/MpFEDAg).
+
+### Editing an existing page
+
+Head to the page you want to edit, and click the top right button which looks like a pen.
+
+The button should redirect you to the correct edit page, it it doesn't:
+- Make sure you are logged into your account
+- If it still leads you to an empty creation page, please report the faulty page in a [new issue in the repository](https://github.com/return-of-modding/ModdingWiki/issues).