From f175609cf38c2648608fc2770cbe2d5fb686b314 Mon Sep 17 00:00:00 2001 From: Griatch Date: Fri, 19 Jun 2020 21:13:51 +0200 Subject: [PATCH] Start to add howto structure --- docs/source/Howto/Howto-Overview.md | 25 +++++++++++++++++++ ...g-Introduction.md => Starting-Overview.md} | 0 docs/source/Setup/Setup-Overview.md | 2 +- docs/source/index.md | 20 +++++++-------- 4 files changed, 36 insertions(+), 11 deletions(-) create mode 100644 docs/source/Howto/Howto-Overview.md rename docs/source/Howto/Starting/{Starting-Introduction.md => Starting-Overview.md} (100%) diff --git a/docs/source/Howto/Howto-Overview.md b/docs/source/Howto/Howto-Overview.md new file mode 100644 index 0000000000..6d94c15446 --- /dev/null +++ b/docs/source/Howto/Howto-Overview.md @@ -0,0 +1,25 @@ +# Tutorials and Howto's + +The documents in this section aims to teach how to use Evennia in a tutorial or +a step-by-step way. They often give hints on about solving a problem or implementing +a particular feature or concept. They will often refer to the +[components](Components/Components-Overview) or [concepts](Concepts/Concepts-Overview) +docs for those that want to dive deeper. + +## Starting Tutorial + +Recommended starting point! This will take you from absolute beginner to making +a small, but full, game with Evennia. Even if you have a very different game style +in mind for your own game, this will give you a good start. + + +```warning:: + + The Starting tutorial is still under development. + +``` + +- [Introduction & Overview](Howto/Starting-Overvew) + + +## diff --git a/docs/source/Howto/Starting/Starting-Introduction.md b/docs/source/Howto/Starting/Starting-Overview.md similarity index 100% rename from docs/source/Howto/Starting/Starting-Introduction.md rename to docs/source/Howto/Starting/Starting-Overview.md diff --git a/docs/source/Setup/Setup-Overview.md b/docs/source/Setup/Setup-Overview.md index 360f751fe4..2d8baa4c55 100644 --- a/docs/source/Setup/Setup-Overview.md +++ b/docs/source/Setup/Setup-Overview.md @@ -1,4 +1,4 @@ -# Server Setup +# Server Setup and Life This documentation covers how to setup and maintain the server, from first install to opening your game to the public. diff --git a/docs/source/index.md b/docs/source/index.md index 02d219143c..ba9375eda1 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -16,20 +16,20 @@ This is the manual of [Evennia](http://www.evennia.com), the open source Python `MU*` creation system. -- [Evennia Introduction](Evennia-Introduction) +- [Evennia Introduction](Evennia-Overview) - [Install & Setup Quickstart](Setup/Setup-Quickstart) - [Begin the starting tutorial](Howto/Starting/Starting-Introduction) - [How to get help](How-To-Get-And-Give-Help) ## Main sections -- [Setting up and running](Setup/Setup-Overview) - More on how to get, start and maintain the server -- [Tutorials and Howto's](Howto) - Explains how to reach particular goals -- [Core components](Components) - The building blocks of Evennia -- [Concepts](Concepts) - Larger-scale concepts and features -- [Contributions](Contrib) - More game-specific tools and code added by the community -- [API](Evennia-API) - the full API-documentation, generated from source -- [TOC](toc) - An alphabetical listing of all regular documentation pages +- [Server Setup, Maintenance and Life](Setup/Setup-Overview) - how to run, maintain and release +- [Tutorials and Howto's](Howto/Howto-Overview) - projects and hints for reaching particular effects and goals +- [Core components](Components) - the core building blocks of Evennia +- [Concepts](Concepts) - larger-scale concepts and features +- [Coding](Coding) - coding and development hints and resources +- [Contributions](Contrib) - game-specific tools and code added by the community +- [API](Evennia-API) - the full API-reference, generated from source +- [Table of Contents](toc) - an alphabetical listing of all regular documentation pages -Want to help improve the docs? See the page on -[Contributing to the docs](Contributing-Docs)! +Want to help improve the docs? See the page on [Contributing to the docs](Contributing-Docs)!