Do you use the MarkdownPanel for your Help systems
-
Hello to everybody,
I am actually finishing my first sample instrument project in HISE (in quite a short time due to the tremendous help through this forum and the exceptional tutorial videos of d.healey).
I am at the point to implement a help system for the users. The MarkdownPanel seems to be the logical and elegant solution, but the forum posts imply that there are more caveats than benefits to it at the moment. Also, I have not seen the Markdown floating tile in any commercial HISE projects so far.
So, boiling it down, my question is:
Do you recommend the inbuild HISE documentation system at the moment or do you think it is better to rely on PDF / Website documentation? -
@asoujon I don't think you'll break user "immersion" if your help button takes them to your docs website. Start there.
Then post launch, you can experiment with things like pulling docs from your repo on launch and using that in the plugin, etc.
Having docs online on your website also gives you good SEO leads as users will more easily find answers if/when they try and look it up on a search engine.
-
@aaronventure Thanks for your thoughts. This is the route I will go, but I still think that the MarkdownPanel is a realy nice approach in this regard.