Skip to content

Editing the docs

pjft edited this page Jul 7, 2020 · 3 revisions

Here are some guidelines on how you can collaborate on editing the product documentation. Before that you probably want to know why we’re inviting you to use GitHub Web. Here is the short version:

  • Follow best industry practices
  • Increase visibility of your work
  • Work like a pro
  • Take control over delivery

How to request an edit

Check our guidelines for repository contributors.

Documentation repositories

These are the documentation repositories you may want to contribute to.

  • docs-product – most of the Product Documentation is here.
  • docs-howtos – How-to Guides, written like tutorials to help the developers extend the functionality of the built-in features.
  • docs-bestpractices – the documents about best practices.

For power users

Here's some extra info about editing OutSystems docs and GitHub.

  • You don't have to use GitHub web interface to create the clone and edit the files. However, you do need it to create pull request on the website.
  • If you plan to edit the docs regularly, you should consider using git on your local machine and setting it up for sync.