-
-
Notifications
You must be signed in to change notification settings - Fork 149
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add component flowchart in the documentation #304
Comments
@obulat Plzzz have a look at the issue. |
I am not sure about the value it would provide. Could you create a sample specifically for the Chooser, @ashu54-aseem , so that we could see what you mean? |
@obulat Since we are discussing the updation of documentation here.So shall we implement an automated technology to keep the track of documentation and always keep it up to date . |
@obulat I'm working on it. I'll present a rough version which would help clear things up. |
@obulat Shall I start implementing this issue? |
@Cronus1007 If you want to work on this, sure! We are always open to improvements to documentation. I'd love to see an example of another project that provides this type of flow chart for front-end components, it's not something I've seen done before but if it's useful to contributors I'm happy to include it. |
@zackkrida I am thinking to implement this issue with mermaid. Have a look https://mermaid-js.github.io/mermaid/#/n00b-gettingStarted |
@Cronus1007, I think that @ashu54-aseem should implement this, as he was the one who proposed it. |
@obulat Okk. |
@obulat Is the uploaded version fine, or are some modifications to be made before I raise a PR? |
@ashu54-aseem I would look at this PR, it should be the last big change before the chooser goes live: #345 |
I want to contribute to this please assign it to me |
Hii I would like to work on this issue please assign me @TimidRobot |
Hey @obulat , I would like to work on this issue |
Hello @TimidRobot i want to solve this issue. can you assign me?. |
Hello @TimidRobot i would like to work on this issue. |
In the README.md, the flow of the project is not well explained. The aim is to add a flow chart to explain the function/component flow in a single cycle so that future contributors would not need to dive deep into dev tools to understand how the app works.
Below is an illustration attached to a workflow chart of a login feature.
In a similar manner, we can create the flowchart for the chooser project as well for better understanding.
The text was updated successfully, but these errors were encountered: