Contribution Guide

The wiki lives in the repository’s docs folder and is built with Astro Starlight. Below is the whole path from a fresh server to a submitted pull request.

Step 1. Environment

Node.js with npm and git. Everything installs from the official sites.

Step 2. Local run

Clone, install, and a dev server on localhost:4321 with hot reload.

Step 3. Edits and PR

Branch, commit, push, and a pull request. Russian pages sit next to the English ones.

Installing Node.js and git

Node.js with npm are needed to build the documentation: download them from the official Node.js website. Git installation instructions live on git-scm.com.

Cloning and running

Clone the repository:

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

Go to the documentation directory and install the dependencies:
root@server: ~
```
cd remnawave-reverse-proxy/docs
npm install
```
Start the dev server:
root@server: ~
```
npm run dev
```
The documentation opens at http://localhost:4321; changes are picked up on the fly.

Where everything lives

English pages live in src/content/docs/, Russian ones in src/content/docs/ru/ under the same paths. When editing a page, check its counterpart in the other language.

Directorydocs documentation root directory
- Directorypublic/
  - …
- Directorysrc
  - Directoryassets/
    Directoryen/
    …
    Directoryru/
    …
  - Directorycomponents/
    …
  - Directorycontent/docs root (en) documentation files
    index.mdx
    Directoryru/ Russian pages, same paths
    index.mdx
  - Directorystyles/
    …
  - content.config.ts
astro.config.mjs
package.json
tsconfig.json

Starlight looks for .md and .mdx files in src/content/docs/: every file becomes a page at its own path. Images go into src/assets/ and are embedded with a relative link; static files like favicons live in public/.

Commands

All commands run from the docs directory:

Command	Action
`npm install`	Installs dependencies
`npm run dev`	Starts a local server at `localhost:4321`
`npm run build`	Builds the site into `./dist/`
`npm run preview`	Shows the build locally before deploying
`npm run astro ...`	Runs CLI commands, for example `astro check`

Sending changes

Create a branch for your change:
root@server: ~
```
git checkout -b my-change
```

Make the changes and commit them:

git add . && git commit -m "docs: my change"

Push the branch and open a pull request in the repository:
root@server: ~
```
git push -u origin my-change
```

After review we will merge the change, and it will appear on wiki.egam.es. Questions are welcome in the Telegram chat.

Starlight documentation

Telegram chat