Skip to content
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

Open
ashu54-aseem opened this issue Jan 15, 2021 · 17 comments
Open

Add component flowchart in the documentation #304

ashu54-aseem opened this issue Jan 15, 2021 · 17 comments
Labels
💻 aspect: code Concerns the software code in the repository 🤖 aspect: dx Concerns developers' experience with the codebase 🕹 aspect: interface Concerns end-users' experience with the software 🌟 goal: addition Addition of new feature good first issue New-contributor friendly help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 🏁 status: ready for work Ready for work

Comments

@ashu54-aseem
Copy link

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.

image

In a similar manner, we can create the flowchart for the chooser project as well for better understanding.

@ashu54-aseem ashu54-aseem added ✨ goal: improvement Improvement to an existing feature 💻 aspect: code Concerns the software code in the repository 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🟩 priority: low Low priority and doesn't need to be rushed labels Jan 15, 2021
@Cronus1007
Copy link
Member

@obulat Plzzz have a look at the issue.

@TimidRobot TimidRobot added 🏁 status: ready for work Ready for work 💻 aspect: code Concerns the software code in the repository 🕹 aspect: interface Concerns end-users' experience with the software 🟩 priority: low Low priority and doesn't need to be rushed help wanted Open to participation from the community and removed ✨ goal: improvement Improvement to an existing feature 💻 aspect: code Concerns the software code in the repository 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🟩 priority: low Low priority and doesn't need to be rushed labels Jan 19, 2021
@cc-open-source-bot cc-open-source-bot added the 🏷 status: label work required Needs proper labelling before it can be worked on label Jan 20, 2021
@obulat
Copy link
Contributor

obulat commented Jan 20, 2021

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?

@Cronus1007
Copy link
Member

Cronus1007 commented Jan 20, 2021

@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 .
Is there any kind of such thing?

@ashu54-aseem
Copy link
Author

@obulat I'm working on it. I'll present a rough version which would help clear things up.

@ashu54-aseem
Copy link
Author

working

This is a rough sketch of what I was alluding to above. This could be of help as a handy guide to see the working of the project.

@Cronus1007
Copy link
Member

@obulat Shall I start implementing this issue?

@zackkrida zackkrida added 🤖 aspect: dx Concerns developers' experience with the codebase good first issue New-contributor friendly and removed 🏷 status: label work required Needs proper labelling before it can be worked on labels Mar 5, 2021
@zackkrida
Copy link
Member

@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.

@Cronus1007
Copy link
Member

@zackkrida I am thinking to implement this issue with mermaid. Have a look https://mermaid-js.github.io/mermaid/#/n00b-gettingStarted

@obulat
Copy link
Contributor

obulat commented Mar 5, 2021

@Cronus1007, I think that @ashu54-aseem should implement this, as he was the one who proposed it.

@Cronus1007
Copy link
Member

@obulat Okk.

@cc-open-source-bot cc-open-source-bot added the 🏷 status: label work required Needs proper labelling before it can be worked on label Mar 6, 2021
@ashu54-aseem
Copy link
Author

@obulat Is the uploaded version fine, or are some modifications to be made before I raise a PR?

@zackkrida
Copy link
Member

@ashu54-aseem I would look at this PR, it should be the last big change before the chooser goes live: #345

@brylie
Copy link
Contributor

brylie commented Sep 9, 2021

It seems that PR #346 was more focused on the development workflow, whereas this feature request is more concerned with component state as the user answers the chooser questions. Is my understanding correct? If so, I propose we close PR #345 and go forward with a component-state diagram, of sorts.

@Tapo41
Copy link

Tapo41 commented Mar 4, 2023

I want to contribute to this please assign it to me

@Pursottam6003
Copy link

Hii I would like to work on this issue please assign me @TimidRobot

@TimidRobot TimidRobot added 🌟 goal: addition Addition of new feature and removed 🏷 status: label work required Needs proper labelling before it can be worked on labels Mar 4, 2024
@abhinav26966
Copy link

Hey @obulat , I would like to work on this issue

@MahtabShah
Copy link

Hello @TimidRobot i want to solve this issue. can you assign me?.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🤖 aspect: dx Concerns developers' experience with the codebase 🕹 aspect: interface Concerns end-users' experience with the software 🌟 goal: addition Addition of new feature good first issue New-contributor friendly help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 🏁 status: ready for work Ready for work
Projects
Status: Backlog
Development

No branches or pull requests