Just point your browser at http://documentation
If you have contributed changes (see below), they may take a few minutes to appear.
The general workflow for contributing documentation changes is:
- Update your local documentation folder
- Make changes using any text editor you want
- Preview the changes to verify they’re correct (it’s recommended to use our Visual Code preview system; more instructions below)
- Upload the changes
These steps are detailed below:
You only need to do this once:
- Make sure you have downloaded or have access to the docs. If you can locate the
docsfolder inside your
gamefolder, then use that directly. If you don’t know what all of that’s about, then [TODO: explain non-BeamNG workers how to use git or whatever method is used in the future]
- Uninstall all versions of Visual Studio Code
- Uninstall all versions of Python
- Run the documentation all-in-one installer: DocTools.exe
- Open Visual Studio Code, go to menu
Open Folder> navigate to the documentation folder >
Always update before you start editing files, as working on outdated files will require extra effort to submit:
- If you can locate the
docsfolder inside your
gamefolder, then you should know how to update that folder. If you don’t know what all of that’s about, then [TODO: explain non-BeamNG workers how to use git or whatever method is used in the future]
.rst file you want with the editor of your choice, modify it and save the file.
For more information on adding links, images, formatting, etc. you can check:
- Formatting Cheat Sheet: Cheat Sheet
- Formatting Tips and Tricks: Tips and tricks if you are in a hurry
If you edit files using Visual Studio Code, and notice huge slowdowns while typing text, then:
- Go to
- Add the following json entry:
- Save and restart Visual Studio Code
You must always preview your changes before uploading them. Use Visual Studio Code to preview changes (you may also use it as your text editor):
- Open Visual Studio code
- Open the
.rstfile you want to preview or edit
Ctrl + Shift + Rto open a preview tab
Ctrl + K,Rto open a preview tab on the right side
Each time the file is saved, the preview tab will update a few seconds later
Every file represents a documentation page. Each topic should have a separate page.
Most text should go in
public/ and then a folder of the corresponding category.
Internal folder is only there for stuff end-users should not be able to access or understand.
- Add a new file, e.g.
- Add a section to it:
Sample Section Title ==========================
- Reference the file in the parent’s toc:
.. toctree:: myfile.rst
There is a small script you can use to automatically build changes on saving a file and automatically reflect them in your local browser.
All commands are command line or terminal commands.