From d89824cdfa24bd6f546e064eeaa7222caa85a2ca Mon Sep 17 00:00:00 2001 From: Tyler Perkins Date: Wed, 20 Dec 2023 19:42:58 -0500 Subject: [PATCH] Add some base documentation --- docs/architecture.md | 3 +++ docs/faq.md | 5 +++++ docs/index.md | 21 +++++---------------- docs/minecraft-server-admin.md | 4 ++++ docs/minecraft-server.md | 4 ++++ 5 files changed, 21 insertions(+), 16 deletions(-) create mode 100644 docs/architecture.md create mode 100644 docs/faq.md create mode 100644 docs/minecraft-server-admin.md create mode 100644 docs/minecraft-server.md diff --git a/docs/architecture.md b/docs/architecture.md new file mode 100644 index 0000000..de21048 --- /dev/null +++ b/docs/architecture.md @@ -0,0 +1,3 @@ +# Services Architecture + +TODO place the entire general architecture of all the services here diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 0000000..48059cf --- /dev/null +++ b/docs/faq.md @@ -0,0 +1,5 @@ +# FAQ + +## Why is it called 'Clortox'? + +Cause it sounds cool. I think. diff --git a/docs/index.md b/docs/index.md index 000ea34..50db6a6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,6 @@ -# Welcome to MkDocs +# Clortox's Domain -For full documentation visit [mkdocs.org](https://www.mkdocs.org). - -## Commands - -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. - -## Project layout - - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +This is the documentation portal for my services, both public and semi-public. +The target audience of this documentation is users of my services, and myself. +Although you may find stuff that may help with your random unrelated project, +don't get your hopes up. diff --git a/docs/minecraft-server-admin.md b/docs/minecraft-server-admin.md new file mode 100644 index 0000000..f460858 --- /dev/null +++ b/docs/minecraft-server-admin.md @@ -0,0 +1,4 @@ +# Minecraft Server Administration + +Thanks for administering the minecraft server for me. +I am very lazy, and don't feel like doing it myself. diff --git a/docs/minecraft-server.md b/docs/minecraft-server.md new file mode 100644 index 0000000..ddc0626 --- /dev/null +++ b/docs/minecraft-server.md @@ -0,0 +1,4 @@ +# Minecraft Server + +I host a semi-public minecraft server. +To access this server, you basically just have to contact me.