generated from tyler/Generic-Template
Add some base documentation
This commit is contained in:
parent
1682e5fdf8
commit
d89824cdfa
3
docs/architecture.md
Normal file
3
docs/architecture.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
# Services Architecture
|
||||||
|
|
||||||
|
TODO place the entire general architecture of all the services here
|
5
docs/faq.md
Normal file
5
docs/faq.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
# FAQ
|
||||||
|
|
||||||
|
## Why is it called 'Clortox'?
|
||||||
|
|
||||||
|
Cause it sounds cool. I think.
|
@ -1,17 +1,6 @@
|
|||||||
# Welcome to MkDocs
|
# Clortox's Domain
|
||||||
|
|
||||||
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
|
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.
|
||||||
## Commands
|
Although you may find stuff that may help with your random unrelated project,
|
||||||
|
don't get your hopes up.
|
||||||
* `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.
|
|
||||||
|
4
docs/minecraft-server-admin.md
Normal file
4
docs/minecraft-server-admin.md
Normal file
@ -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.
|
4
docs/minecraft-server.md
Normal file
4
docs/minecraft-server.md
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
# Minecraft Server
|
||||||
|
|
||||||
|
I host a semi-public minecraft server.
|
||||||
|
To access this server, you basically just have to contact me.
|
Loading…
Reference in New Issue
Block a user