Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-26 09:46:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Convert master docs to use MyST

Browse source
This commit is contained in:
Griatch 2021-10-26 21:14:33 +02:00
parent 6e03216cd9
commit d229ff024c
359 changed files with 3275 additions and 4567 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/source/Docs-refactoring.md
View file

@ -31,19 +31,19 @@ This would help in development to quickly refer to where a resource is located.
### Kovitikus (Sept. 11, 2019)
[Batch Code](./Batch-Code-Processor) should have a link in the developer area. It is currently only
[Batch Code](./Batch-Code-Processor.md) should have a link in the developer area. It is currently only
listed in the tutorials section as an afterthought to a tutorial title.
***
In regards to the general structure of each wiki page: I'd like to see a table of contents at the
top of each one, so that it can be quickly navigated and is immediately apparent what sections are
covered on the page. Similar to the current [Getting Started](./Getting-Started) page.
covered on the page. Similar to the current [Getting Started](./Getting-Started.md) page.
***
The structuring of the page should also include a quick reference cheatsheet for certain aspects.
Such as [Tags](./Tags) including a quick reference section at the top that lists an example of every
Such as [Tags](./Tags.md) including a quick reference section at the top that lists an example of every
available method you can use in a clear and consistent format, along with a comment. Readers
shouldn't have to decipher the article to gather such basic information and it should instead be
available at first glance.