Adding a new page

To add a new page to the documentation:

In Visual Studio Code, add a new markdown file to the correct folder in the repository, ensuring it carries the .md extension.
Add a UID at the top of your new file. Add this UID in a metadata section. For example:
```
---
uid: contributing
---
```
Note

Do not use spaces in a UID.

Add the new page to the relevant toc.yml file so that it is included in the table of contents. To do so, specify the name and UID as follows:

- name: The name of the page as it should appear in the table of contents
  topicUid: The file UID

For example:

- name: Basic concepts
  topicUid: BasicConcepts

To add the new page at a lower level in the table of contents, use the following syntax:

- name: The name of the page at the level above the page you are adding
  topicUid: The file UID
  items:
    - name: The name of the new page as it should appear in the table of contents
      topicUid: The file UID of the new page

Add new page to toc.yml file

Check if there are any smaller content overviews that also need to be updated with a link. For example, if you add something in the user guide, usually there is a page at a higher level in the guide that gives an overview of all underlying pages. Add a link to your new page on that page. See Links and cross-references.
When your page is ready, create a pull request.

Table of Contents

Adding a new page

Note