Every plugin should have basic steps to use plugin.
Like GIT website
Hey Ajay,
I certainly agree, but as the Forge is community driven how do you propose the system be enhanced to ensure plugins are appropriately documented?
Hi Craig,
Thanks for agreeing
I recommend a form to be filled by developer who is uploading plugin.
Form should have required fields with basic questions and there must be a reviewer who can review plugin before going to Forge.
How much are you paying the Forge component developers to do this?
J.Ja
Also, I want to point out that GitHub (as you referenced) does not require any kind of instructions. If someone adds a Readme document to their repository, it displays it, but there is nothing forcing developers to put something there.
Is there a specific component that you have in mind? You can always request to join a component's team and add any documentation that is missing.
I think that a "How-To" section for each component on the forge could be a great help. Almost like the documentation for the OutSystems platform, with a hierarchy of class/function/object/properties/methods etc.
It will serve as a form of documentation with workable examples and will be indexed by search engines, which I think will greatly help the community. The current way of having a demo project or Try Now link does not seem to cater to everyone's need.
Hi, Ajax! Your idea was released two months after, but I've noticed that it has never been marked as implemented. I'm doing it now! Since then, I hope you've been using and taking advantage of the Documentation tab! ;)
Keep the ideas coming.
Ângela
It could be nice if the forge page have one specific space to add documentation about the use of the component. If possible that can generate a pdf for download.
However it could be optional, but encouraged.
Hi Alberto,
Thank you for sharing this idea. We are working on it.
Cheers
Daniela
Hmmm. You can see the future, Alberto?
Thanks for your feedback Daniela
Regards
If it are the component team members that are supposed to add the documentation, then I think this idea is already recently implemented. I uploaded yesterday a component and there is now a documenation section that can be filled out. It shows as the last tab on the component in the forge.
Thank you for your suggestion, the idea is implemented.
Keep sending more ideas, we are listening.
Thanks. Nice to know