From 009f5e87cc25c71bcfc5140070c1d2b9e100d3d6 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sun, 11 Oct 2020 20:43:57 +0200 Subject: [PATCH] Cleanup of doc index --- docs/source/Wiki-Index.md | 2 -- docs/source/index.md | 33 +++++++-------------------------- 2 files changed, 7 insertions(+), 28 deletions(-) diff --git a/docs/source/Wiki-Index.md b/docs/source/Wiki-Index.md index 782a08b57d..84973726f9 100644 --- a/docs/source/Wiki-Index.md +++ b/docs/source/Wiki-Index.md @@ -1,7 +1,5 @@ # Wiki Index - - *This wiki index is automatically generated. Do not modify, your changes will be lost.* ## A-Z diff --git a/docs/source/index.md b/docs/source/index.md index f94fe0ea5d..e6db4ece09 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -1,36 +1,21 @@ - - - # VERSION WARNING -> This is the experimental static v0.95 documentation of Evennia, _automatically_ generated from the +> This is the static v0.95 documentation of Evennia, originally converted from the old > [evennia wiki](https://github.com/evennia/evennia/wiki/) at 2020-10-11 18:06:03.062022. -> There are known conversion issues which will _not_ be addressed in this version - refer to -> the original wiki if you have trouble. -> -> Manual conversion and cleanup will instead happen during development of the upcoming v1.0 -> version of this static documentation. - +> While we will fix outright mistakes, minor typos and visual conversion issues will _not_ be +> addressed in this version. +> A new new refactored version of the docs are being prepared for the v3.0 of the documentation. # Evennia Documentation This is the manual of [Evennia](http://www.evennia.com), the open source Python `MU*` creation system. -You can [Search][search] the documentation as well as browse all pages alphabetically in the -[Index](./Wiki-Index). If you have trouble with unclear documentation, please let us know on our -[mailing list][group], over [IRC][chat] or by dropping a note in our quick no-registration [online -suggestion box][form]! +You can Search the documentation on the left. If you have trouble with unclear documentation, please +let us know on our [mailing list][group], over [IRC][chat] or by making a new [documentation issue](github:issue). There is [a lengthier introduction](./Evennia-Introduction) to read. You might also want to read about [how to get and give help](./How-To-Get-And-Give-Help). -| ![Getting Started][icon_new]| ![Admin Docs][icon_admin] | ![Builder Docs][icon_builder] | -![Developer-Central][icon_devel] | ![Tutorials][icon_tutorial] | [![API][icon_API]](api:evennia) | - -|[Getting Started](./Getting-Started)| [Admin Docs](./Administrative-Docs) | [Builder Docs](Builder- -Docs) | [Developer Central](./Developer-Central) | [Tutorials & Examples](./Tutorials) | -[API](api:evennia) | - - The [Getting Started](./Getting-Started) page helps installing and starting Evennia for the first time. - The [Admin Docs](./Administrative-Docs) covers running and maintaining an Evennia server. @@ -38,14 +23,10 @@ time. - The [Developer Central](./Developer-Central) describes how Evennia works and is used by coders. - The [Tutorials & Examples](./Tutorials) contains help pages on a step-by-step or tutorial format. - The [API](api:evennia) documentation is created from the latest source code. +- The [TOC](./toc) lists all regular documentation pages. - - The [TOC](./toc) lists all regular documentation pages. - - -[search]: https://www.google.com/cse/publicurl?cx=010440404980795145992:6ztkvqc46je [group]: https://groups.google.com/forum/#%21forum/evennia [chat]: http://tinyurl.com/p22oofg -[form]: http://tinyurl.com/c4tue23 [icon_new]: https://raw.githubusercontent.com/wiki/evennia/evennia/images/bright4.png [icon_admin]: https://raw.githubusercontent.com/wiki/evennia/evennia/images/speedometer26.png [icon_builder]: https://raw.githubusercontent.com/wiki/evennia/evennia/images/toolbox3.png