Cleanup of docs

This commit is contained in:
Griatch 2023-07-23 21:43:58 +02:00
parent 461d45c5a2
commit 9e6f828cf8
6 changed files with 29 additions and 31 deletions

View file

@ -1,17 +1,17 @@
# Part 1: What We Have
```{sidebar} Beginner Tutorial Parts
- [Introduction](./Beginner-Tutorial-Overview.md)
- [Introduction](../Beginner-Tutorial-Overview.md)
<br>Getting set up.
- *Part 1: [What We Have](Part1/Beginner-Tutorial-Part1-Overview.md)*
- *Part 1: [What We Have](./Beginner-Tutorial-Part1-Overview.md)*
<br>A tour of Evennia and how to use the tools, including an introduction to Python.
- Part 2: [What We Want](Part2/Beginner-Tutorial-Part2-Overview.md)
- Part 2: [What We Want](../Part2/Beginner-Tutorial-Part2-Overview.md)
<br>Planning our tutorial game and what to consider when planning your own.
- Part 3: [How We Get There](Part3/Beginner-Tutorial-Part3-Overview.md)
- Part 3: [How We Get There](../Part3/Beginner-Tutorial-Part3-Overview.md)
<br>Getting down to the meat of extending Evennia to make your game.
- Part 4: [Using What We Created](Part4/Beginner-Tutorial-Part4-Overview.md)
- Part 4: [Using What We Created](../Part4/Beginner-Tutorial-Part4-Overview.md)
<br>Building a tech-demo and world content to go with our code.
- Part 5: [Showing the World](Part5/Beginner-Tutorial-Part5-Overview.md)
- Part 5: [Showing the World](../Part5/Beginner-Tutorial-Part5-Overview.md)
<br>Taking our new game online and letting players try it out.
```
In this first part, we'll focus on what we have out of the box with Evennia. We'll familiarize you with the tools and how to find things that you are looking for. We will also dive into some of the things you'll need to know to utilize the system fully, including giving you a brief rundown of Python concepts. If you are an experienced Python programmer, some sections may feel a bit basic -- yet seeing things in the context of Evennia will still be worthwhile.

View file

@ -5,17 +5,17 @@ The tutorial game is under development and is not yet complete, nor tested. Use
```
```{sidebar} Beginner Tutorial Parts
- [Introduction](./Beginner-Tutorial-Overview.md)
- [Introduction](../Beginner-Tutorial-Overview.md)
<br>Getting set up.
- Part 1: [What We Have](Part1/Beginner-Tutorial-Part1-Overview.md)
- Part 1: [What We Have](../Part1/Beginner-Tutorial-Part1-Overview.md)
<br>A tour of Evennia and how to use the tools, including an introduction to Python.
- Part 2: [What We Want](Part2/Beginner-Tutorial-Part2-Overview.md)
- Part 2: [What We Want](../Part2/Beginner-Tutorial-Part2-Overview.md)
<br>Planning our tutorial game and what to consider when planning your own.
- *Part 3: [How We Get There](Part3/Beginner-Tutorial-Part3-Overview.md)*
- *Part 3: [How We Get There](./Beginner-Tutorial-Part3-Overview.md)*
<br>Getting down to the meat of extending Evennia to make your game.
- Part 4: [Using What We Created](Part4/Beginner-Tutorial-Part4-Overview.md)
- Part 4: [Using What We Created](../Part4/Beginner-Tutorial-Part4-Overview.md)
<br>Building a tech-demo and world content to go with our code.
- Part 5: [Showing the World](Part5/Beginner-Tutorial-Part5-Overview.md)
- Part 5: [Showing the World](../Part5/Beginner-Tutorial-Part5-Overview.md)
<br>Taking our new game online and letting players try it out.
```

View file

@ -1,17 +1,17 @@
# Part 4: Using What We Created
```{sidebar} Beginner Tutorial Parts
- [Introduction](./Beginner-Tutorial-Overview.md)
- [Introduction](../Beginner-Tutorial-Overview.md)
<br>Getting set up.
- Part 1: [What We Have](Part1/Beginner-Tutorial-Part1-Overview.md)
- Part 1: [What We Have](../Part1/Beginner-Tutorial-Part1-Overview.md)
<br>A tour of Evennia and how to use the tools, including an introduction to Python.
- Part 2: [What We Want](Part2/Beginner-Tutorial-Part2-Overview.md)
- Part 2: [What We Want](../Part2/Beginner-Tutorial-Part2-Overview.md)
<br>Planning our tutorial game and what to consider when planning your own.
- Part 3: [How We Get There](Part3/Beginner-Tutorial-Part3-Overview.md)
- Part 3: [How We Get There](../Part3/Beginner-Tutorial-Part3-Overview.md)
<br>Getting down to the meat of extending Evennia to make your game.
- *Part 4: [Using What We Created](Part4/Beginner-Tutorial-Part4-Overview.md)*
- *Part 4: [Using What We Created](./Beginner-Tutorial-Part4-Overview.md)*
<br>Building a tech-demo and world content to go with our code.
- Part 5: [Showing the World](Part5/Beginner-Tutorial-Part5-Overview.md)
- Part 5: [Showing the World](../Part5/Beginner-Tutorial-Part5-Overview.md)
<br>Taking our new game online and letting players try it out.
```
We now have the code underpinnings of everything we need. We have also tested the various components and has a simple tech-demo to show it all works together. But there is no real coherence to it at this point - we need to actually make a world. In part four we will expand our tech demo into a more full-fledged (if small) game by use of batchcommand and batchcode processors.

View file

@ -1,17 +1,17 @@
# Part 5: Showing the World
```{sidebar} Beginner Tutorial Parts
- [Introduction](./Beginner-Tutorial-Overview.md)
- [Introduction](../Beginner-Tutorial-Overview.md)
<br>Getting set up.
- Part 1: [What We Have](Part1/Beginner-Tutorial-Part1-Overview.md)
- Part 1: [What We Have](../Part1/Beginner-Tutorial-Part1-Overview.md)
<br>A tour of Evennia and how to use the tools, including an introduction to Python.
- Part 2: [What We Want](Part2/Beginner-Tutorial-Part2-Overview.md)
- Part 2: [What We Want](../Part2/Beginner-Tutorial-Part2-Overview.md)
<br>Planning our tutorial game and what to consider when planning your own.
- Part 3: [How We Get There](Part3/Beginner-Tutorial-Part3-Overview.md)
- Part 3: [How We Get There](../Part3/Beginner-Tutorial-Part3-Overview.md)
<br>Getting down to the meat of extending Evennia to make your game.
- Part 4: [Using What We Created](Part4/Beginner-Tutorial-Part4-Overview.md)
- Part 4: [Using What We Created](../Part4/Beginner-Tutorial-Part4-Overview.md)
<br>Building a tech-demo and world content to go with our code.
- *Part 5: [Showing the World](Part5/Beginner-Tutorial-Part5-Overview.md)*
- *Part 5: [Showing the World](./Beginner-Tutorial-Part5-Overview.md)*
<br>Taking our new game online and letting players try it out.
```

View file

@ -7,12 +7,6 @@ Want more details about something? See the documentation for Evennia's core [Com
## Beginner Tutorial
```{sidebar}
```{toctree}
:maxdepth: 1
Howtos-Overview.md
```
```
Recommended starting point! This will take you from absolute beginner to making
a small -- but full -- game with Evennia. Other tutorials and how-to's tend to assume you are already familiar with the concepts explained in the Beginner Tutorial.
@ -30,6 +24,10 @@ Part 3 and onwards are still under development.
./Beginner-Tutorial/Part5/Beginner-Tutorial-Part5-Overview
```
```{toctree}
:maxdepth: 1
Howtos-Overview.md
```
## How-To's
```{toctree}

View file

@ -17,7 +17,7 @@ This is the manual of [Evennia](https://www.evennia.com), the open source Python
## Tutorials and Howtos
- [The Beginner Tutorial](Howtos/Howtos-Overview.md#beginner-tutorial) - learn the basics and build a small game (in progress)
- [Tutorials and Howto's](Howtos/Howtos-Overview.md#howtos) - mixed tutorials and help articles to learn Evennia
- [Tutorials and Howto's](Howtos/Howtos-Overview.md#how-tos) - mixed tutorials and help articles to learn Evennia
- [Coding with Evennia](Coding/Coding-Overview.md) - resources and hints for coding and development
## The Evennia Library