Home
praneesha edited this page Jun 28, 2022
·
8 revisions
Welcome to the ballerina-dev-website Wiki!
This provides a comprehensive overview of the documentation aspects of the Ballerina language.
Ballerina language documentation consists of the main components below.
- Ballerina By Example - play the role of a quick reference example for language features, libraries, and extensions that are used frequently. It can be thought of as a cut-down version of the User Guide, which tries to introduce the features with quick examples to get an in-depth but practical understanding of a feature.
- Learn - provides detailed explanations of how a specific feature will work along with some comprehensive examples. It will not necessarily cover all the APIs that are available (that will be covered in API Docs). For example, when considering the I/O APIs, it will not be feasible to cover all the I/O types and operations supported by them.
- API Docs - include all the possible options and parameter information that are relevant when using an API along with suitable examples.
Therefore, the combination of the Ballerina By Examples, Learn, and API Docs represent the complete knowledge required for a Ballerina developer. There will be an overlap of content between these. For example, the User Guide has examples and functionality details to explain language-level features.