Merge pull request #1 from DexlerXD/docs-revive

Docs revive
SerbiaStrong-220 · Aug 21, 2024 · 1396306 · 1396306
2 parents ee41191 + b404b01
commit 1396306
Show file tree

Hide file tree

Showing 12 changed files with 72 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+site/
diff --git a/docs/development/creating-simple-system.md b/docs/development/creating-simple-system.md
@@ -0,0 +1,2 @@
+# Создание простейшей системы с компонентом
+<!-- пока пусто... -->
diff --git a/docs/development/dev-introduction.md b/docs/development/dev-introduction.md
@@ -0,0 +1,43 @@
+# Введение в разработку
+
+Разработка Space Station 14 ведётся в основном на фреймворке .NET и, соответственно, на языке программирования C#.
+
+Это означает, что для введения в код SS14 нужно **хотя бы** знать основы C#, а также понимать, что такое **ООП (Объектно-Ориентированное Программирование)** на базовом уровне.
+
+## Ресурсы для изучения 
+### [**METANIT**](https://metanit.com/sharp/tutorial/)
+Очень хороший и доступный ресурс для начинающих программистов (и не только), объясняет многие вещи с практическими примерами, лично я (**автор этой страницы - Dexler**) начинал свой путь отсюда.
+
+### [**Официальное руководство по C# от Microsoft**](https://learn.microsoft.com/ru-ru/dotnet/csharp/)
+Официальный источник информации (та самая **БАЗА**). Максимально подобно объясняет, что и как работает в C#. Для начинающих может быть тяжело из-за иногда не самых простых примеров и стиля подачи информации.
+
+Также стоит отметить, что не все страницы переведены на русский язык.
+
+### [**SoloLearn**](https://www.sololearn.com/ru/)
+Один из популярных вариантов изучения языков программирования "игровым способом". По сути, изучение материала вёдется по аналогии с сервисом Duolingo.
+!!! warning ""
+	Без изучения вышеперечисленных ресурсов вы никуда с SoloLearn не уйдете. Данный ресурс может пригодиться для раннего изучения .NET, но не более.
+
+## Полезный софт
+Для полноценной работы над проектом вам необходима рабочая среда.
+Ниже предоставлены популярные IDE/редакторы кода, которые используются для работы.
+
+[**Visual Studio 2022**](https://visualstudio.microsoft.com/ru/vs/community/)
+
+[**Visual Studio Code**](https://code.visualstudio.com/)
+
+[**VSCodium (open-source версия VSCode)**](https://vscodium.com/)
+
+[**JetBrains Rider (платно)**](https://www.jetbrains.com/rider/)
+
+Также, для того, чтобы публиковать свои изменения и держать наш репозиторий под контролем, мы используем систему управления версиями - [**Git**](https://git-scm.com/).
+
+[**Шпаргалка по Git'у**](https://training.github.com/downloads/ru/github-git-cheat-sheet/).
+
+А удалённо репозитории хранятся, в основном (как, например, наш репозиторий SS220), на сервисе [**GitHub**](https://github.com/).
+
+## Начало пути
+Для работы с билдом вам нужна будет [**локальная версия нашего репозитория и локальный сервер при нем**](../localhost.md).
+
+- [ECS](ecs.md)
+- [Создание простейшей системы с компонентом](creating-simple-system.md)
diff --git a/docs/development/ecs.md b/docs/development/ecs.md
@@ -0,0 +1,2 @@
+# ECS
+<!-- пока пусто... -->
diff --git a/...атели с Сиерры(Infinity)/backstory-gen.md → docs/disdocs/sierra/backstory-gen.md b/...атели с Сиерры(Infinity)/backstory-gen.md → docs/disdocs/sierra/backstory-gen.md
diff --git a/...Исследователи с Сиерры(Infinity)/index.md → docs/disdocs/sierra/index.md b/...Исследователи с Сиерры(Infinity)/index.md → docs/disdocs/sierra/index.md
@@ -29,10 +29,10 @@
 Основным геймплеем отдела являются:
 
 - Исследовательская рутина - поэтапное исследование планеты с помощью аппаратуры разделённое на тиры (основываясь на первичном исследовании заказывается более сложная и дорогая аппаратура для дальшейшего исследования), строительство инфраструктуры (энергообеспечение исследовательской апаратуры, антенна связи и т.п.). Так же включает в себя исследование природных аномалий (подробнее в диздоке генератора планеты).
-- Исследование процедурно генерируемого комплекса с [**процедурно генерируемой историей**](backstory-gen), исследуемой через документы комплекса. Отчасти копирует механику IO из CM-SS13 - для упрощения поиска одни документы будут указывать на местонахождение других. Часть документов будет представлена ввиде зашифрованных дискет, требующих расшифровки с помощью терминала на станции.
+- Исследование процедурно генерируемого комплекса с [**процедурно генерируемой историей**](backstory-gen.md), исследуемой через документы комплекса. Отчасти копирует механику IO из CM-SS13 - для упрощения поиска одни документы будут указывать на местонахождение других. Часть документов будет представлена ввиде зашифрованных дискет, требующих расшифровки с помощью терминала на станции.
 - Исследование истории комплекса подоразумевает логический конец - это может быть как богатства, секретная документация об экспериментах, так и мидраундовй антаг. Исследование подаразумевает и мелкие награды, как пример - артефакт, находящийся в хранилище под паролем. 
 - Интеграция с целями станции - захват живой фауны для зоопарка, сбор ДНК для хранилища и т.п.
 
 ## Прочие ссылки
-[**Генерация бэкстори**](backstory-gen)  
+[**Генерация бэкстори**](backstory-gen.md)  
 [**Генерация планеты**](planet-gen.md)
diff --git a/...дователи с Сиерры(Infinity)/planet-gen.md → docs/disdocs/sierra/planet-gen.md b/...дователи с Сиерры(Infinity)/planet-gen.md → docs/disdocs/sierra/planet-gen.md
diff --git a/docs/ecs.md b/docs/ecs.md
diff --git a/docs/index.md b/docs/index.md
@@ -9,4 +9,6 @@
 	Вики находится на этапе заполнения, поэтому большая часть информации тут отсутствует. Её можно найти в документации от официальных разработчиков SS14 [(вот здесь)](https://docs.spacestation14.com).
 
 ## Для начинающих
-[**Сборка и запуск локального сервера**](localhost.md)
+[**Сборка и запуск локального сервера**](localhost.md)
+
+[**Введение в разработку**](development/dev-introduction.md)
diff --git a/docs/localhost.md b/docs/localhost.md
@@ -11,7 +11,7 @@
 
 * Git - [https://git-scm.com](https://git-scm.com)
 * Python 3.7 или новее - [https://www.python.org](https://www.python.org) - качать именно с оф. сайта а не с Windows Store иначе могут возникнуть проблемы со скриптом
-* .NET 7 SDK x64 - [https://dotnet.microsoft.com/en-us/download](https://dotnet.microsoft.com/en-us/download)
+* .NET 8 SDK x64 - [https://dotnet.microsoft.com/en-us/download](https://dotnet.microsoft.com/en-us/download)
 
 ## Клонирование кода
 После установки всего вышеперечисленного теперь нужно скачать код проекта через Git.

diff --git a/docs/mapping.md → docs/mapping/mapping.md b/docs/mapping.md → docs/mapping/mapping.md
@@ -13,7 +13,7 @@
 ## Подготовка
 Маппинг происходит на сервере, поэтому для маппинга необходимо поднять свой локальный сервер. Для этого будет необходимо сначала скачать актуальную версию кода проекта из репозитория используя Git, а затем собрать её в конфигурации *Release*.
 
-О том как это сделать можно прочитать в нашем [**подробном гайде**](localhost.md).
+О том как это сделать можно прочитать в нашем [**подробном гайде**](../localhost.md).
 
 ## Маппинг
 ### Запуск mapping-режима

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -29,6 +29,7 @@ plugins:
   - git-revision-date-localized:
       enable_creation_date: true
       fallback_to_build_date: true
+  - git-authors
 
 extra:
   social:
@@ -39,4 +40,19 @@ markdown_extensions:
   - admonition
   - pymdownx.details
   - pymdownx.superfences
-  - md_in_html
+  - md_in_html
+
+nav:
+  - Главная: index.md
+  - Сборка и запуск локального сервера: localhost.md
+  - Диздоки:
+    - Исследователи с Сиерры(Infinity):
+      - disdocs/sierra/index.md
+      - disdocs/sierra/backstory-gen.md
+      - disdocs/sierra/planet-gen.md
+  - Маппинг:
+    - mapping/mapping.md
+  - Разработка:
+    - development/dev-introduction.md
+    - development/ecs.md
+    - development/creating-simple-system.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# Создание простейшей системы с компонентом
		<!-- пока пусто... -->