Merge branch 'main' of https://github.com/HazeVista/AstroGregExsilium

Author: HazeVista

.github/workflows/deploy.yml

@@ -0,0 +1,46 @@
+name: Deploy Docs
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          pip install mkdocs-material 
+          pip install mkdocs-awesome-pages-plugin
+
+      - name: Build
+        run: mkdocs build -f docs/mkdocs.yaml --strict
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs/site'
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -8,6 +8,9 @@
 !mods/panorama/
 !panoramas/
 !scripts/
+!docs/
+!.github/
+
 
 # Add files in main directory
 !.gitattributes

docs/CONTRIBUTING.md

@@ -0,0 +1,145 @@
+# Contributor Info / Styleguide
+
+For consistency, please follow the following styleguide when submitting PRs.
+This page is directly lifted from [GregTech Modern] (https://github.com/GregTechCEu/GregTech-Modern)
+
+
+## Filenames & Basic Page Structure
+
+The file structure and basic page layout must follow these conventions: 
+
+- For each section, create a directory with a short, descriptive name in `Title Case`.
+- File names should only contain `A-Z`, `a-z`, `0-9`, `-` and `_` (no spaces).  
+- Directory names must use dashes (`-`) instead of spaces.
+- If you want to add a short description of what a section is about, include an `index.md` in its directory.
+- Every page of the docs must include a Markdown front matter block, containing _at least_ its title, followed by
+  two empty lines.
+- Every page must start with a level-1 heading. No other level-1 headings may be added.
+
+Note that the page name/title must be as short and descriptive as possible, as it's displayed in the navigation area.  
+You can, however, choose a longer version for the page _header_:
+
+```markdown
+---
+title: My Page Name
+---
+
+
+# This is my Custom Page Header!
+
+Page content here...
+```
+
+Contrary to filenames, both the title and header are **not** limited to specific characters. 
+
+
+## Empty Lines
+
+Please consider the following conventions for empty lines:
+
+- At least two empty lines before each heading
+- Exactly one line after each heading
+- Separate each "element" of a page by an empty line inbetween
+  (code blocks, lists, [admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/), etc.)
+
+
+## Formatting
+
+Please use the following formatting rules for standard markdown:
+
+- Use double asterisks for bold text (`**bold**`) and underscores for italics (`_italics_`)
+- Each code block must include a language whenever possible, so that syntax highlighting is applied correctly
+
+
+## Index Pages
+
+Only use index pages for a short description of what the current section is about.
+
+Do not include any important documentation on index pages!  
+You may link to certain relevant pages (either inside the current section, or in other sections) though. 
+
+
+## Admonitions
+
+Use [admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) in the following situations:
+
+- If you want to provide potentially useful, additional info about a feature, use an `info` admonition.
+- For "see also" references, use an `info inline end` admonition.
+- For tips / recommendations on _when_ or _how_ to use a feature, use he `tip` admonition type.
+  - For general notes on _when_ or _how_ to use a specific feature (in development related docs), use the `note` type.
+- For warning about possible bugs or unwanted behavior, use the `warning` type.
+- If a feature may result in destructive actions in certain scenarios, use the `danger` type.
+- For providing code examples, use the `example` type.  
+  - **Always** provide a title for code examples, even if it's simply "Example usage".  
+  - Use collapsible blocks (`??? example "my example title"` instead of `!!!`) for code examples where possible.  
+    _In some situations this might not be as useful as using a non-collapsible block. Just fall back to `!!!` in these cases._
+- For pages or sections that are not documented yet, use `!!! failure "Not yet documented"`
+- For links, use the (custom) `link` type.
+
+We suggest adding an empty line after the title for consistency, like in the following example.  
+It is **strongly recommended** to include a custom, descriptive title for your admonition, if possible.
+
+
+```markdown
+!!! note "My descriptive title"
+    
+    This is my note's content
+```
+
+
+### Admonitions for experimental or not-yet-merged features
+
+If a feature is either not yet merged or simply not stable yet, please add a title-only `warning inline end` before its
+description, as shown below.
+
+For additional info (e.g. which branch the feature is currently in), add a `<br>` tag in the title, followed by the
+additional info in italics.  
+If your additional information needs to be more detailed than that, consider using a collapsible admonition instead.
+
+```markdown
+!!! warning inline end "Not merged yet.<br>_Branch: `my-branch-name`_"
+
+Paragraph containing the feature's description...
+```
+
+Here are some good examples you could use as the first line of your warning:
+
+- Experimental
+- Unstable
+- Not yet implemented
+- Not merged yet
+
+
+## Annotations
+
+Use [annotations](https://squidfunk.github.io/mkdocs-material/reference/annotations/) in the following situations:
+
+- Explanatory comments in code examples (preferred over including these as an actual comment)
+- Additional explanations to a specific aspect of your documented feature
+- An explanation for a technical term used in your documentation
+
+There must be an empty line before the first annotation or they won't work properly.
+
+Also add an empty line between each annotation if at least one in the current block is longer than a single line.  
+In that case, add two empty lines after the end of the annotation list.
+
+Annotations must be numbered starting at 1 **for each block** of consecutive annotations.  
+If they are separated by another element, you need to start at 1 again for the next block of annotations:
+
+
+~~~markdown
+```java
+someVar.someMethod(); // (1)
+return someVar; // (2)
+```
+
+1. annotation 1 for the first code block
+2. annotation 2 for the first code block
+
+
+```java
+someVar.anotherMethod(); // (1)
+```
+
+1. annotation 1 for the second code block
+~~~

docs/README.md

@@ -0,0 +1,84 @@
+#  AstroGregExsilium Documentation
+
+This documentation project is built using [MkDocs](https://www.mkdocs.org/#).  
+This page is directly lifted from [GregTech Modern] (https://github.com/GregTechCEu/GregTech-Modern)
+For an automatically updating live preview in your browser, run `mkdocs serve`
+
+## Contributing
+
+When contributing to this project, please refer to the [Styleguide](./CONTRIBUTING.md).  
+This helps us in keeping the documentation consistent.
+You will also find examples of when to use specific features of `mkdoc` and `mkdocs-material`.
+
+## Quickstart Guide
+If you want to contribute to the docs without setting up a dedicated code environment, you can go to the `<> Code` button on the main page of the repository.
+
+![image](https://github.com/user-attachments/assets/27458f12-15af-475e-9e79-f45b890d4707)
+
+Then, click `Codespaces` and create a new codespace on `1.20.1`
+
+![image](https://github.com/user-attachments/assets/42b23f92-5277-4825-8a61-a44855f4e33c)
+
+From there, you'll be taken to a VSCode instance in your browser, where you can edit any of the docs files in `/content`.  
+If you want to preview your changes, just run `mkdocs serve` and click the link it gives you.
+
+Once you're happy, commit these changes and make a pull request for us to review using the `Source Control` tab on the left. This will automatically create a fork of our repository for you.
+
+If you come back to work on the docs, you can use a codespace again. You might need to `pull` to bring your codespace up to date, which you can do by pressing this button in the `Source Control` tab.
+
+![image](https://github.com/user-attachments/assets/7d1246d2-f091-4452-bdb3-edf221902503)
+
+## Running in Gradle
+
+To run mkdocs locally, run the mkdocsServe task in gradle.
+
+Either in the gradle sidebar, click documentation/mkdocsServe, or run .`/gradlew mkdocsServe`.
+
+Click on the link it gives you at the bottom to open the local copy, and pages will automatically update with content as you save your files.
+
+You can also run documentation/mkdocsBuild. This will build the documentation in `docs/site`, which you can either host yourself or just open in a browser.
+
+## Installing Required Dependencies & Run Locally
+
+If you want to manually install and go through the steps to run locally, you can follow the steps below.
+
+Please run all commands from this section inside the `docs` folder!
+
+**First, setup a venv for python:**
+
+```bash
+python -m venv .venv
+```
+or:
+```bash
+python3 -m venv .venv
+```
+
+**Now activate the venv:**
+
+Windows:
+```cmd
+.venv\Scripts\activate
+```
+Linux / MacOS:
+```bash
+source .venv/bin/activate
+```
+
+**Install the required dependencies:**
+```bash
+pip install -r requirements.txt
+```
+
+**Run locally**:
+```bash
+mkdocs serve
+```
+
+## MkDocs Plugins
+
+The following plugins for MkDocs are being used:
+- https://squidfunk.github.io/mkdocs-material/
+- https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
+
+When working on the docs locally, the plain `mkdocs` commands should be used to view the changes made to the version of the docs you are currently working on, like the previously mentioned `mkdocs serve`.

docs/content/.pages

@@ -0,0 +1,4 @@
+nav:
+  - 'Home': 'index.md'
+  - 'Gameplay'
+  - 'Development'

docs/content/Development.md

@@ -0,0 +1 @@
+# Developer Documentation

docs/content/Development/begin/index.md

@@ -0,0 +1 @@
+# Development

docs/content/Gameplay.md

@@ -0,0 +1,3 @@
+# Gameplay Overview
+
+Welcome to the core of **AstroGregExsilium**. This guide covers the primary changes and additions to the GregTech ecosystem.

docs/content/Gameplay/machines/index.md

@@ -0,0 +1 @@
+# Machines

docs/content/Gameplay/progression/index.md

@@ -0,0 +1,2 @@
+# Progression
+