Contributing
The documentation is written by the people who make missions. If you figured out how to set something up and it took you more than ten minutes — write it down, and the next person will spend one.
How to submit a change
Section titled “How to submit a change”You need a GitHub account. Every change is reviewed and appears on the site within a few minutes after that.
Edit a page
Section titled “Edit a page”- At the bottom of the page click Edit page — GitHub opens its source file.
- Make the change.
- Click Commit changes…, briefly describe what you changed, then Propose changes and Create pull request.
Add a page
Section titled “Add a page”- Open the right folder in the repository: the reference is in
reference/. - Click Add file → Create new file.
- Name the file in Latin letters with hyphens — the name becomes the page address:
reference/kill-zones.md→/reference/kill-zones/. - For a reference page, copy the template into it and fill it in.
- Submit a pull request, as with an edit.
Screenshots
Section titled “Screenshots”- Open the
src/assets/folder in the repository. - Click Add file → Upload files and upload the image. The file name — in Latin letters and meaningful, for example
freezezone_settings.png. - Insert it into the text with a path from the page:
- from a reference page (
reference/…) —; - from other pages —
.
- from a reference page (
Pages in en/ sit one level deeper, so they need one more ../.
The image is compressed during the build, and on the site it opens full size on click.
If you don’t want to deal with GitHub
Section titled “If you don’t want to deal with GitHub”Write in Discord or open an issue: what’s wrong, what’s missing, what question is left. Someone will make the change for you.
What to write
Section titled “What to write”- Reference — one page per thing a mission maker sets up: a component, an entity, a setting. Example: Groups and slots.
- Common mistakes — “I did this and it doesn’t work, because…”. Everything asked in Discord more than once goes here.
- Russian is the primary language. An English page is a translation of the Russian one, at the same path in the
en/folder. If you edited a Russian page, you may leave the English one alone: an “outdated translation” notice appears on it by itself, andnpm run i18nlists every page that is behind. - Write plainly and to the point — like a good technical manual. No slang and no jokes, but no officialese either: not “this component performs the blocking”, but “the component blocks”. Address the reader directly and use the imperative in instructions: “place”, “enable”.
- Name fields the way the editor does, with the code name next to them: “Countdown Seconds (
m_CountdownSeconds)”. That way the reader finds the field in Workbench instead of guessing what you translated. - Show rather than retell. A screenshot with the field circled on it replaces a paragraph of description.
- Name the mod version if the behavior appeared or changed in a specific version.
- Not sure — write it anyway, but add a “Needs verification” block. An incomplete page is more use than a blank one.
- Explain edits to someone else’s text. Found a mistake — fix it and write in the pull request what you changed and why.
Markup
Section titled “Markup”Pages are written in Markdown. Besides the usual headings, lists and tables, these come in handy:
Link to another page — an address from the site root with a trailing slash: [Zones](/reference/zones/), on English pages [Zones](/en/reference/zones/).
Path to a prefab or config — as a link that opens the file in Workbench: ~EchoLobby for the mod’s files, ~ArmaReforger for vanilla ones:
[`Prefabs/Zones/EH_Polyline_KillZone.et`](enfusion://ResourceManager/~EchoLobby:Prefabs/Zones/EH_Polyline_KillZone.et)Callout blocks:
:::noteAdditional information.:::
:::tipA useful tip.:::
:::caution[Needs verification]What exactly needs to be checked.:::
:::dangerSomething that can break the mission.:::Order in the menu is set at the top of the file:
---title: Titledescription: One sentence about the pagesidebar: order: 5---