SelfPrivacy/docs.selfprivacy.org
1
0
Fork 0
mirror of https://git.selfprivacy.org/SelfPrivacy/docs.selfprivacy.org.git synced 2024-11-13 23:53:16 +00:00
Code Issues Projects Releases Wiki Activity

Add 'README.md'

Browse source
This commit is contained in:
Illia Chub 2022-01-19 09:05:57 +02:00
parent ad0e1fee99
commit 281bccf677
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md Normal file
View file

@ -0,0 +1,8 @@
# Процедура внесения изменений в документацию
1. Склонировать репозиторий.
2. При редактировании репозитория, изменения вносить в формате MarkDown, в файлах, расположеных по пути ```src/ru/src```
3. После внесения изменений, протестировать выполнение сборки документации при помощи команды ```mdbook build```
4. MdBook можно установить из реестра пакетов Rust: ```cargo install mdbook```
5. Закоммитить и запушить в репозиторий.
6. Изменения будут доступны в https://docs.selfprivacy.org