From 418ee532a33df48b3fda14060e124f2f688b6689 Mon Sep 17 00:00:00 2001 From: Kitzunu <24550914+Kitzunu@users.noreply.github.com> Date: Sat, 12 Jun 2021 17:57:16 +0200 Subject: chore: Wiki standards (#531) --- docs/standard-operating-procedure.md | 2 ++ docs/wiki-standards.md | 25 +++++++++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 docs/wiki-standards.md diff --git a/docs/standard-operating-procedure.md b/docs/standard-operating-procedure.md index da6ada8..a3a2c45 100644 --- a/docs/standard-operating-procedure.md +++ b/docs/standard-operating-procedure.md @@ -7,3 +7,5 @@ - [File Headers](file-headers) - [Issue Tracker Standards](issue-tracker-standards) + +- [Wiki Standards](wiki-standards) diff --git a/docs/wiki-standards.md b/docs/wiki-standards.md new file mode 100644 index 0000000..d597821 --- /dev/null +++ b/docs/wiki-standards.md @@ -0,0 +1,25 @@ +# WIKI STANDARDS + +## FILE NAMING: + +DATABASE TABLES files are to be named exactly as it is in the database, + +ALL OTHER FILES are to be named in `lower case` and to use `-` (dashes) for spaces. + +FILES SHOLD NOT contain any special characters other than `-` (dashes). If we want a file named C++ we name it cpp. + +ALL WIKI FILES should end with with `.md`. + +## DATABASE TABLE FILES: + +ALL DATABASE TABLE FILES should be present in it's correct DATABASE FILE. + +When adding/removing a table it should also be updated in `database-auth.md` `database-characters.md` `database-world.md` + +## FILE HEADERS + +THE FILE SHOULD ALWAYS START WITH `# File Name`. (This is to display correct info in the tab.) + +## ARCHIVED PAGES: (Not yet implemented) + +ALL ARCHIVED PAGES that could potentially have some sort of value should be added in the `archive.md` list and links to these pages should be removed from other places in the wiki. -- cgit