-
-
Notifications
You must be signed in to change notification settings - Fork 21
Contributing to the documentation
So you have a cool help patch that would fit in the Fuse documentation? We’d be happy to integrate it! Please follow the following guidelines so we can keep a coherent and meaningful documentation.
First, if you’re not sure how help patches work in vvvv gamma, please read the Providing Help section from the Gray Book.
Like vvvv, Fuse follows the documentation system to structure its documentation. When you create a patch, it can either be an Explanation, a Reference, a Tutorial or a HowTo (vvvv also introduces the Example patch type that is just a rough example without any comments).
If you’re not sure about which type your help patch is, don’t panic : either ask in the chat or put anything you want and we can sort this out together.
As you might have noticed, all help patches have kind of the same patching style and structure. When creating your own, you can draw some inspiration from the existing ones to structure and clean it.
There are no strict guidelines for this point, as we know that all help patches might not benefit from following the same rigid skeleton, but try to stay coherent with the existing ones as much as possible.
In short : align your links, stay concise and don’t hesitate to use tooltips when necessary!
You can either post your help patch in the forum, or make a pull request on our github repo.
- Via the forum : visit the dedicated topic on the forum and submit your help patch there.
- Via github : simply fork our repo and make a pull request with your help patch. If you’re not sure about doing that and still would like to embrace the power of git, you can read the following articles : About forks, and Create a pull request from a fork. You can also watch the one and only Dan Shiffman explaining what are forks and pull requests. And if you’re still stuck, just ping us in the chat and we’ll be happy to help!