FLINT-UI icon indicating copy to clipboard operation
FLINT-UI copied to clipboard

Documentation: Write a user story for Point Model

Open HarshCasper opened this issue 2 years ago • 6 comments

What is the current documentation state?

Currently, we don't have any specific documentation on specific user stories for FLINT-UI. We need to document them one by one to ensure users have an understanding base for getting started with FLINT models.

Where is this stated?

No response

Why do you want to improve the statement?

No response

Proposed Statement

Setup FLINT-UI locally or use the temporary deployment available here, and write a document about Point Model and how to use it. It should contain instructions around the usage of the model and what the specific data mean.

Additional context.

Take assistance from the User Interface working group (#user-interface) on understanding more about FLINT-UI and how to employ it.

cc: @chicken-biryani @padmajabhol

HarshCasper avatar Apr 13 '22 07:04 HarshCasper

A good start would be to learn what a user story is.

There are a lot of tools like Agile that will help you with it.

However, we would like to create a table in google docs for the user stories.

The template for the table is-

I want to (Task to be performed) | So that I can (Achieve goal) | Components involved | Additional notes.

Remember you don't have to fill all rows and column in a go. There will be places you don't understand things...

Go at your own pace and discuss with us... And keep us updated about your progress...

An informal conversation over slack works as well.

The task is a little lengthy but would help you get great insights and it would make you an extremely valuable contributor.

shloka-gupta avatar Apr 13 '22 08:04 shloka-gupta

can i take this on, this seems like it would be a challenge and it is something i would absolutely love to try out

Iheanacho-ai avatar Apr 13 '22 12:04 Iheanacho-ai

hi @HarshCasper @chicken-biryani is this still being worked on? If not, I'd like to.

rahulsh18 avatar Sep 09 '22 10:09 rahulsh18

@rahulsh18 we may need some help with the FLINT Handbook... Maybe you could help us with that?

shloka-gupta avatar Sep 09 '22 10:09 shloka-gupta

oh for sure

rahulsh18 avatar Sep 09 '22 11:09 rahulsh18

This issue has not seen any activity for the past 30 days. If this Issue would not see any further updates in the next 7 days, it would be automatically closed. Please comment on the issue if you would like to discuss on this further.

github-actions[bot] avatar Dec 09 '22 02:12 github-actions[bot]

Thanks for raising an issue! We at moja global appreciate your concerns and views to help us improve. We capitalize on fostering a welcoming environment for all our contributors. This issue was closed because it has been stalled for 7 days with no activity. If you would like to discuss it further, please create another issue or reach out to a maintainer on the prospects of getting it resolved.

github-actions[bot] avatar Dec 17 '22 01:12 github-actions[bot]