From d6f259945308111fdaa01d0e01a17ecff748c683 Mon Sep 17 00:00:00 2001
From: Timur Ismagilov <bouncepaw2@ya.ru>
Date: Sun, 18 Sep 2022 14:23:50 +0300
Subject: [PATCH] Document the file structure

Fixes #175
---
 help/en/file_structure.myco | 19 +++++++++++++++++++
 help/view_help.html         |  3 ++-
 help/web.go                 |  1 +
 3 files changed, 22 insertions(+), 1 deletion(-)
 create mode 100644 help/en/file_structure.myco

diff --git a/help/en/file_structure.myco b/help/en/file_structure.myco
new file mode 100644
index 0000000..3a79687
--- /dev/null
+++ b/help/en/file_structure.myco
@@ -0,0 +1,19 @@
+= File structure
+//This article is intended for wiki administrators.//
+
+Every Mycorrhiza wiki is stored in one directory. This document explaints the structure of this directory, what files can be there, and what you should do with them.
+
+You can edit all of the files manually, if you want, just do your best to not break anything.
+
+* `config.ini` is the [[/help/en/config_file | configuration file]]. It has comments in it, feel free to edit it.
+* `wiki.git/` is the Git repository of the wiki, it has all hyphae in it. You can edit it directly, but do not forget to make Git commits with your changes and [[/reindex]] you wiki afterwards.
+* `static` holds static data. You can access data there from your wiki with addresses like `/static/image.png`.
+** `static/favicon.ico` is your wiki's favicon, accessed at [[/favicon.ico]] by browsers.
+** `static/common.css` redefines the engine's default style, if exists. You probably don't need to use it.
+** `static/custom.css` is loaded after the main style. If you want to make visual changes to your wiki, this is probably where you should do that.
+* `categories.json` contains the information about all categories in your wiki.
+* `users.json` stores users' information. The passwords are not stored, only their hashes are, this is safe. Their tokens are stored in `cache/tokens.json`.
+* `interwiki.json` holds the interwiki configuration.
+* `cache/` holds cached data. If you back up your wiki, you can omit this directory.
+** `cache/tokens.json` holds users' tokens. By deleting specific tokens, you can log out users remotely.
+* Mycomarkup migration markers are hidden files prefixed with `.mycomarkup-`. You should probably not touch them.
diff --git a/help/view_help.html b/help/view_help.html
index 4f379b2..5797ffa 100644
--- a/help/view_help.html
+++ b/help/view_help.html
@@ -16,7 +16,7 @@
 		<li><a href="/help/en">{{block "main" .}}Main{{end}}</a></li>
 		<li><a href="/help/en/hypha">{{block "hypha" .}}Hypha{{end}}</a>
 			<ul>
-                <a href="/help/en/media">{{block "media" .}}Media{{end}}</a>
+                <li><a href="/help/en/media">{{block "media" .}}Media{{end}}</a></li>
 			</ul>
 		</li>
 		<li><a href="/help/en/mycomarkup">{{block "mycomarkup" .}}Mycomarkup{{end}}</a></li>
@@ -42,6 +42,7 @@
 				<li><a href="/help/en/whitelist">{{block "whitelist" .}}Whitelist{{end}}</a></li>
 				<li><a href="/help/en/telegram">{{block "telegram" .}}Telegram authentication{{end}}</a></li>
 				<li><a href="/help/en/interwiki">{{block "interwiki" .}}Interwiki{{end}}</a></li>
+				<li><a href="/help/en/file_structure">{{block "file structure" .}}File structure{{end}}</a></li>
 			</ul>
 		</li>
 	</ul>
diff --git a/help/web.go b/help/web.go
index a16d0ad..c6b3516 100644
--- a/help/web.go
+++ b/help/web.go
@@ -40,6 +40,7 @@ var (
 {{define "whitelist"}}Белый список{{end}}
 {{define "telegram"}}Вход через Телеграм{{end}}
 {{define "interwiki"}}Интервики{{end}}
+{{define "file structure"}}Файловая структура{{end}}
 `
 )