Editing these docs

Anyone with access can improve these docs from a web browser. You don’t need to install anything or know how to code.

Before you start

You need a free GitHub account, and a maintainer needs to give it access to the docs. Ask a maintainer if you don’t have access yet.

Edit a page

1. Go to /admin/ and choose Sign In with GitHub.
2. Pick a section on the left (for example Systems), then the page you want to change.
3. Edit the text. Use the toolbar for headings, bold, lists, links and images, just like a word processor.
4. Choose Save. Your change is saved as a draft.
5. When you’re happy with it, set the status to Ready for review.

Add a new page

In the section where the page belongs, choose New Page. Fill in:

• Title: the page heading.
• Short description: one sentence shown in search results.
• Sidebar → Position in sidebar: optional. Lower numbers appear higher in the menu.

Add images

Use the image button in the toolbar and upload a file. Screenshots and photos are fine, but please keep files under about 2 MB.

What happens next

Every change becomes a pull request, which is a proposed change a maintainer reviews before it goes live. A preview link of the site with your change is built automatically. Once a maintainer approves and merges it, the live site updates within a couple of minutes.

Tip

Small fixes, like typos or a clearer sentence, are always welcome. You don’t have to rewrite a whole page.