ofDocsofdocs contribute

contribute

ofDocs aims to make contributing to openFrameworks documentation easier by allowing direct editing of markdown files within the app. This will write changes to disk, so will only work when running ofDocs locally, after which changes can be submitted via Github.

To set up ofDocs locally you can follow the instructions in the root README, and clone ofSite. Be sure to also read the original submission guidelines which contain instructions for structure and formatting.

Changes can then be submitted via the command line, via Github or with a desktop client. For example:


# using a Python pull request helper

pip3 install git-pull-request

# after editing a page within ofSite...

cd openFrameworks/ofSite
git branch my-new-edits
git commit -a -m "updated description for ofArduino"
git pull-request