diff --git a/README.md b/README.md new file mode 100644 index 0000000..9177d7b --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# Hercules documentation + +This repository contains Hercules documentation. + +- **Live docs:** [https://docs.herc.ws/](https://docs.herc.ws/) +- **How to contribute:** [https://docs.herc.ws/contributing/editing-the-docs/](https://docs.herc.ws/contributing/editing-the-docs/) diff --git a/docs/contributing/editing-the-docs.md b/docs/contributing/editing-the-docs.md new file mode 100644 index 0000000..09a31ec --- /dev/null +++ b/docs/contributing/editing-the-docs.md @@ -0,0 +1,38 @@ +# Editing the Docs + +The Hercules docs could always use help. It is an ever changing repository of useful information related to Hercules, such as configuration, connecting, setting up, Compiling and scripting. However, please follow the below points when trying to edit. + +1. Do not create pages or guides for custom content. Base client specific content is OK, as this is the main point behind Hercules. However, leave patchers, custom patches or plugins, setup of custom items or mobs, or control panels out. +2. Be sure you write in proper and complete English. +3. For code examples, be sure you follow [Hercules' Coding Style](./coding-style.md). + + +## Contributting +Hercules docs is completely based on the repository files, in order to contribute to it, simply +submit a [Pull request](./creating-pull-requests.md) to the [Hercules-docs repository](https://github.com/HerculesWS/hercules-docs). + + +## Setup +Hercules docs uses mkdocs-material. + +You will need to have Python3 installed and install `mkdocs-material` package. + +You can install it with `pip install mkdocs-material` or `pip3 install mkdocs-material`. + +For more information about installing mkdocs-material, and other alternatives, +see [Mkdocs Material's getting started](https://squidfunk.github.io/mkdocs-material/getting-started/#installation) + +After installing mkdocs-material, in order to run hercules docs in your machine, you will have to: + +1. Clone hercules-docs repository to your local machine +2. Open a terminal in the folder and run `mkdocs serve` +3. The documentation should be running at http://localhost:8000 + + +## Editing +The documentation is entirely written in Markdown, with some extensions from mkdocs and mkdocs-material. + +If you are new to markdown or want to know about the extended syntax from mkdocs, please check the following links: + +- [Markdown Syntax](https://www.markdownguide.org/basic-syntax/) +- [Mkdocs Material Reference](https://squidfunk.github.io/mkdocs-material/reference/) diff --git a/docs/contributing/editing-the-wiki.md b/docs/contributing/editing-the-wiki.md deleted file mode 100644 index 58bf95b..0000000 --- a/docs/contributing/editing-the-wiki.md +++ /dev/null @@ -1,10 +0,0 @@ -# Editing the Wiki - -The Hercules wiki could always use help. It is an ever changing repository of useful information related to Hercules, such as configuration, connecting, setting up, Compiling and scripting. However, please follow the below points when trying to edit. - -1. Do not create pages or guides for custom content. Base client specific content is OK, as this is the main point behind Hercules. However, leave patchers, custom patches or plugins, setup of custom items or mobs, or control panels out. -2. Be sure you follow all of the applicable [[Style Guides|Style Guide]] for the content you are trying to create. -3. Be sure you write in proper and complete English. Again, reference the Style Guide for specific examples. -4. Do not engage in Edit wars. -5. Do not initiate the deletion of a page unless you are a Hercules staff member. If you have a page you are requesting for deletion, please include the relevant [[Template]]. - diff --git a/docs/index.md b/docs/index.md index 340d11b..d8c93d0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,12 +13,12 @@ License version 1.2, this means that the wiki and any works put on it can be edi distributed, provided all history and copylefts remain intact. Please do not create pages for custom content, such as custom projects not relating to Hercules in any way. A full list -of content that should not be on the wiki is listed at [Editing the wiki](contributing/editing-the-wiki.md). +of content that should not be on the wiki is listed at [Editing the Docs](contributing/editing-the-docs.md).
![](assets/GitRepo.png) [Git Repository](https://github.com/HerculesWS/Hercules) - | ![](assets/WikiEdit.png) [Editing the wiki]() + | ![](assets/WikiEdit.png) [Editing the Docs](contributing/editing-the-docs.md) | ![](assets/Support.png) [Assistance & Support](https://herc.ws/board/)