Making the boring part less tedious.
Do a minimum of documentation is healthy for the project, for the author and the contributors.
The goal is help newcomers to have smooth onboarding on vlingo, so, we choose the documentation tool that help us reach that goal as faster as possible.
The best way to share how a new feature works is code some use case. All features should have a source code example.
github.com/vlingo/vlingo-examples
Public documentation - docs.vlingo.io
👥 When the feature is enough important, the component responsible will ask you for a sort of more serious documentation. You will hav to coordinate with him/her.
Write access to docs.vlingo.io is limited.
Component documentation - JavaDocs
Add useful comments into exposed API methods.
Documenting the internal methods is a nice to have, and more if the method is doing some complex stuff that might not be easy to understand, but we won't ask you to document everything.
Important architectural decisions should be documented under /docs folder on each component repository.
Keep track of changes on CHANGELOG.md file on each component repository.
In case you prefer to make a tutorial, guideline or sample code in your own Blog, Medium, GitHub or a Video, we will link your work to help others reach your learning material.
We keep the decision of listing or not.