Description
Introduction
While the current documentation is quite helpful, it could benefit from a more comprehensive set of usage examples, organized per use case type. Specifically, I believe that adding examples for pure API, ML API, and Flama CLI would greatly improve the user experience and help new users get started more quickly.
Context
Not having a properly organised and comprehensive usage examples can be a significant hurdle for new users of the library. Without these examples, users may struggle to understand how to use the library for their specific needs, and they may miss out on valuable features and functionalities. By providing a set of usage examples organized per use case type, we can help users understand how the library can be used in various contexts and increase their confidence in using it effectively.
Process
To create a comprehensive set of usage examples, I think it would be great to have examples that cover the following:
-
Pure API Examples: These examples would show users how to use and create Flama APIs, with the different schema libraries supported, and use all the functionality offered by Flama, e.g. connectors to DBs, pagination, etc.
-
ML API Examples: These examples should be align with those in the official documentation, and further expand around certain specificities of the library which, because of the very technical nature of them, have not been totally put into practice in the official documentation.
-
CLI Examples: These examples would show users how to use the Flama command-line interface (CLI) to run, deploy, and interact with ML models, beyond what's alredy in the official documentation.
Expected Result
By providing a comprehensive set of usage examples, users will have a much better understanding of how to use the library in various contexts, and they will be more likely to use the library effectively for their specific needs. This will lead to a better overall user experience and increased adoption of the framework.
Current Result
Currently, the examples provided in the repository are not well organised per use case type, which can make it difficult for users to understand how to use the library effectively. This can lead to frustration and a lack of adoption, as users may not see the value in the library without clear examples.
Possible Fix
To address this issue, I propose adding a comprehensive set of usage examples organized per use case type. These examples could be presented in a clear and organized way, with each type of example clearly labeled and organized under separate headings. Additionally, the examples could be presented in a step-by-step format, with clear explanations of each step and what it accomplishes.