chooser
chooser copied to clipboard
creativecommons
Add component flowchart in the documentation
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.
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 . Is there any kind of such thing?
@obulat I'm working on it. I'll present a rough version which would help clear things up.
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 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 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: https://github.com/creativecommons/chooser/issues/345
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.
