/botland-documentation

Open-sourced documentation for Bot Land

Bot Land Documentation

Prerequisites

  1. Have git properly configured on your machine.
  2. Fork this repository.
  3. Clone your fork.
  4. Download the Bot Land documentation editor.

Editing

  1. Edit the documentation using the Bot Land documentation editor.
  2. Review your changes using the Export button at the top right of the editor.
  3. Save the archive containing your changes.

Submitting

Changes made outside of the editor may be rejected. If you can't edit something in the editor or you encounter a problem, please open an issue.

  1. Create a new branch in your fork.
  2. Paste the modified files.
  3. Push the new branch to your fork.
  4. Submit a pull request with your changes.
  5. Optionally ping Adam on Discord to tell him that you've made a change (Adam13531#3531).

Troubleshooting

If you have any new issues, please report them.

A Git-related issue pops up at launch

For example, this error:

git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

For me, this showed up when using CMD on Windows. To fix it, I had to launch the application from bash with ssh-agent running. This probably indicates an issue with your Git configuration though, for which this guide may help.