Обновление документации

Чтобы обновить сайт документации, вам нужно:

Браузер

edit page

  1. Нажмите кнопку Edit page внизу страницы.

alt text

  1. Вы будете перенаправлены на страницу github сайта документации. Здесь вы можете редактировать и просматривать ваши изменения.

Note

  • .md в CONTRIBUTING.md означает файлы markdown
  • .mdx в docs.mdx означает MarkDown eXtended
    • это надмножество markdown с поддержкой javascript и компонентов jsx
    • они немного сложнее, но позволяют использовать интерактивные компоненты

propose changes window

  1. Нажмите кнопку Commit changes... в правом верхнем углу, чтобы закоммитить ваши изменения. Убедитесь, что вы:
  • Написали короткое и описательное сообщение коммита (Commit message)
  • Отметили галочкой Create a new branch for this commit and start a pull request

comparing changes page

  1. Вы будете перенаправлены на страницу Comparing changes. Нажмите кнопку Create pull request, чтобы создать пул-реквест.

open a pull request page

  1. Нажмите кнопку Create pull request, чтобы открыть PR. Для небольших изменений можно оставить тело PR пустым.

Локальная разработка

Note

Этот раздел предполагает, что у вас есть некоторые знания git и javascript. Конечно, вы можете изучать их по ходу дела.

Чтобы запустить сайт документации локально, вам нужно:

  • установить deno для форматирования и генерации автоматической документации

Настройка сервера разработки

(Cataclysm-BN) $ deno task docs serve

# или если вы уже находитесь в директории docs
(Cataclysm-BN/docs) $ deno task serve

Вы сможете получить доступ к сайту документации по адресу http://localhost:3000. Сервер разработки будет автоматически перезагружаться при внесении изменений в документацию.

Автоматическая генерация страниц

Документация Lua и CLI генерируется автоматически из исходного кода. Чтобы сгенерировать их, перейдите в корень проекта и запустите:

(Cataclysm-BN) $ deno task docs:gen

Лицензия

  • Внося вклад в файлы markdown (включая, но не ограничиваясь файлами .md и .mdx), вы соглашаетесь лицензировать свои вклады под CC-BY-SA 3.0, той же лицензией, что и игра.

  • Внося вклад в исходный код страницы документации (включая, но не ограничиваясь файлами .ts), вы соглашаетесь лицензировать свои вклады под AGPL 3.0.