Skip to main content

Contribute to these docs

Create a new markdown document by running the command below and following instructions. A new document will be available in the section and at the path you just selected. The sidebars.json is also automatically updated using this generator.

npm run new
Pro tip

You can edit sidebars.json manually if you want to move/remove pages or add/edit/move categories. This should not conflict with the Plop generator (npm run new) in any way.

Consider where to put your documentation​

  • There are these Markdown docs, useful for getting started or figuring out where to start with something
  • There is Storybook, useful for showing components, what they are capable of, and maybe extra notes that can be useful for developers or designers
  • There is JSDoc/PHPDoc or similar to document methods

Make sure to reference to other places of documentation whenever needed, if it makes things more clear.

How do you write effective documentation?
  • Start with what the reader needs
  • Keep things short and concise
  • Begin with an outline

Learn more about writing effective documentation in this video.

Copying text​

Whenever you copy a special character make sure to use UTF-8 code or remove those if not required. When we copy content from other sites it might look exactly same but the encoding can cause the issue.

Since we were looking for a bug resulting from bad encoding, we pay more attention to it!