Руководство по внесению изменений

Вики живёт в папке docs репозитория и собирается на Astro Starlight. Ниже весь путь от чистого сервера до отправленного pull request.

Шаг 1. Окружение

Node.js с npm и git. Всё ставится с официальных сайтов.

Шаг 2. Локальный запуск

Клон, зависимости и dev-сервер на localhost:4321 с горячей перезагрузкой.

Шаг 3. Правки и PR

Ветка, коммит, push и pull request. Русские страницы лежат рядом с английскими.

Установка Node.js и git

Node.js с npm нужны для сборки документации: скачайте их с официального сайта Node.js. Инструкции по установке git есть на git-scm.com.

Клонирование и запуск

Склонируйте репозиторий:

git clone https://github.com/eGamesAPI/remnawave-reverse-proxy

Перейдите в директорию документации и установите зависимости:
root@server: ~
```
cd remnawave-reverse-proxy/docs
npm install
```
Запустите dev-сервер:
root@server: ~
```
npm run dev
```
Документация откроется на http://localhost:4321, изменения подхватываются на лету.

Где что лежит

Английские страницы лежат в src/content/docs/, русские в src/content/docs/ru/ с теми же путями. Меняя страницу, проверьте её парную версию на другом языке.

Директорияdocs корневая директория документации
- Директорияpublic/
  - …
- Директорияsrc
  - Директорияassets/
    Директорияen/
    …
    Директорияru/
    …
  - Директорияcomponents/
    …
  - Директорияcontent/docs корневая (en) директория документации
    index.mdx
    Директорияru/ русские страницы, те же пути
    index.mdx
  - Директорияstyles/
    …
  - content.config.ts
astro.config.mjs
package.json
tsconfig.json

Starlight ищет файлы .md и .mdx в src/content/docs/: каждый файл становится страницей по своему пути. Изображения складываются в src/assets/ и встраиваются относительной ссылкой, статические файлы вроде фавиконов живут в public/.

Команды

Все команды выполняются из директории docs:

Команда	Действие
`npm install`	Устанавливает зависимости
`npm run dev`	Запускает локальный сервер на `localhost:4321`
`npm run build`	Собирает сайт в `./dist/`
`npm run preview`	Показывает сборку локально перед деплоем
`npm run astro ...`	Выполняет команды CLI, например `astro check`

Отправка изменений

Создайте ветку под правку:
root@server: ~
```
git checkout -b my-change
```
Внесите изменения и закоммитьте:
root@server: ~
```
git add . && git commit -m "docs: моя правка"
```
Отправьте ветку и откройте pull request в репозитории:
root@server: ~
```
git push -u origin my-change
```

После проверки мы вольём правку, и она появится на wiki.egam.es. Вопросы можно задать в Telegram-чате.

Документация Starlight

Telegram-чат