At the moment, there is only one getting started example (Create App v3.14.1) which is known to be misleading and incomplete, as noted in #5602 and #5712. Creating new Getting Started examples, which could be easily understood by everyone, is the goal of this project. We can achieve this result by completing the following:
Deliverables
In the first part, we would design from scratch the user experience (UX) of getting started examples. We should pay attention to make them accessible to everyone by defining an innovative communication approach, which includes different modalities (audio,visual,etc.) and accommodates different levels of expertise; the full set of requirements is shown as a table below.
Philosophy and Design Principles
Design Guidelines
Wireframe / Simple Prototype (Milestone)
In the second part, we would create a reusable template that should help us stay consistent with our design guidelines. This document must contain what is common to all getting started examples.
Create Document Template
Test Document Template
List of Getting Started Examples (Milestone)
Finally, we would craft the examples by adding contents and documentation to each.
Prepare Contents
Add documentation
Quality Assurance
(Optional) Reiterate
Expected outcomes
Create beginner examples to be added to Getting Started section of Jina documentation.
Multi-modal Getting Started Examples
Summary:
At the moment, there is only one getting started example (Create App v3.14.1) which is known to be misleading and incomplete, as noted in #5602 and #5712. Creating new Getting Started examples, which could be easily understood by everyone, is the goal of this project. We can achieve this result by completing the following:
Deliverables In the first part, we would design from scratch the user experience (UX) of getting started examples. We should pay attention to make them accessible to everyone by defining an innovative communication approach, which includes different modalities (audio,visual,etc.) and accommodates different levels of expertise; the full set of requirements is shown as a table below.
In the second part, we would create a reusable template that should help us stay consistent with our design guidelines. This document must contain what is common to all getting started examples.
Finally, we would craft the examples by adding contents and documentation to each.
Expected outcomes
Create beginner examples to be added to Getting Started section of Jina documentation.
Desired skills
Python, Markdown, HTML, CSS, .JS
Details