meta: added github meta files

docs/FORMAT.md

@@ -0,0 +1,63 @@
+---
+layout: default
+title: Format types
+nav_order: 2
+---
+# Formats
+
+Following the specific JSON format is important as it allows us to easily process your domain without any issues. If the correct format is not followed, you will be told and the pull request will **not** be merged. 
+
+When submitting your pull request, we ask that you add your email under the email key in the file. This is so that we can contact you if anything is due to change or if your subdomain has violated laws, terms or anything of that nature. Invalid contact details will end up with you being refused a subdomain. 
+
+## JSON Format Template
+```json
+{
+  "repo": "",
+
+  "owner": {
+    "username": "",
+    "email": ""
+  },
+
+  "target": {
+    "record-type": {
+       "name": "", 
+       "value": ""
+     }
+  },
+
+  "proxied": false
+}
+```
+
+**Breakdown of the template**:
+- *"repo"* - This is your repository, the place where the code for the site is. If you don't have a repository you can leave this field blank or remove the field.
+- *"owner"* - This is a category for your information. This section needs to be filled out, or your pull request will **not** be merged.
+  - *"username"* - This is where you put your GitHub username.
+  - *"email"* - This is where you put your email address.
+- *"record-type"* - This is a category for the record information.
+  - *"name"* - This is the desired subdomain.
+  - *"value"* - This is the value for the record, for example with an `A` record it would be an IP.
+- *"proxied"* - If you want the record proxied through Cloudflare. If you don't know what it means, leave it to false.
+
+## JSON Example 
+```json
+{
+    "repo": "https://github.com/ML-comm/ddns",
+
+    "owner": {
+        "username": "ml-comm",
+        "email": "[email protected]"
+    },
+
+    "target": {
+        "CNAME": {
+            "name": "demo",
+            "value": "ml-comm.github.io"
+        }
+    },
+
+    "proxied": true
+}
+```
+*You can find a demo file [here](https://github.com/ml-comm/ddns/blob/main/domains/demo.json).*

docs/INDEX.md

@@ -0,0 +1,31 @@
+---
+layout: default
+title: Getting Started
+nav_order: 1
+---
+
+## Getting Started
+
+- [Fork](https://github.com/ml-comm/ddns/fork) the ddns repository to your GitHub account
+- Create a new file under the `domains` directory.
+  - Name the file according to the sub-domain name that you would like, for example `my-project.json`.
+
+    *The file path and name should look somewhat similar to this: `domains/my-project.json`*
+- Read the format documentation [here](FORMAT.md) to see what json format you should be following.
+- Check over your file to make sure that everything looks right and matches the format.
+- Open a Issue first via [here](https://github.com/ml-comm/ddns/issues/new?assignees=&labels=request&projects=&template=REQUEST.yml&title=%5BREQUEST%5D%3A+) to discuss the subdomain you want to register.
+- When your request is approved, open a pull request with the file you created.
+- Check up on your pull request. Sometimes we will comment or add a new label, these can mean that you domain is unavailable or something is wrong with the file. If this is the case, don't worry! You are still able to get a domain, but you may have to either change the file name or check over the file again.
+- Leave the rest down to us, we will make sure that the subdomain is sorted out.
+- Once your pull request has been merged, enjoy the subdomain. If you ever need to change the subdomain, don't hesitate to open a new pull request to change any of the details.
+
+---
+
+Your pull request **will not** be merged if:
+- The records provided includes invalid/unpermitted record types. If this happens we will notify you and request changes.
+- It violates users privacy.
+- It serves malicious content.
+- Not related to Machine Learning / Data Science / Artificial Intelligence / Research.
+- The subdomain is already taken.
+
+*If your subdomain is inactive, it may be purged. We will try and notify you before purging via the email you provided.*

docs/_config.yml

@@ -0,0 +1,8 @@
+remote_theme: just-the-docs/just-the-docs
+plugins:
+- jekyll-remote-them
+title: ddns-mlcommunity-dev
+color_scheme: dark
+search_enabled: true
+gh_edit_link: true
+gh_edit_link_text: "Edit this page on GitHub."