Contributors' guide

First time contributing?

Check out the contributors' presentation before continuing.

Adding a new page to an existing category

Example: you want to add a new file talking about OCPP standards to the OCPP category.

1. create a file under /docs/Controller/OCPP named ocpp-standards.md

filename conventions

• Lowercase
• Add the immediate folder the file lives under to the filename <folder>-<topic>.md

2. Open docs\Controller\sidebars.js
3. Search for the category. Here it's OCPP.

...
    {
      type: 'category',
      label: 'OCPP',
      link: {
        type: 'doc',
        id: 'OCPP/index',
      },
      items: [
      ]
    },
...

4. Under items:, add the file path to your new document omitting the file extension. In our case this would be:

...
    {
      type: 'category',
      label: 'OCPP',
      link: {
        type: 'doc',
        id: 'OCPP/index',
      },
      items: [
        'OCPP/ocpp-standards'
      ]
    },
...

Save your changes. You should see the new file in the docs outline. In our example you'd navigate to OCPP > ocpp-standards inside the local preview in your browser.

Titling a page

See here.