-
Notifications
You must be signed in to change notification settings - Fork 2
QUA-993: Refactor " Flows" userguide. #851
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
base: main
Are you sure you want to change the base?
Conversation
RafaelOsiro
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general Let's deep dive the Flow content. What's the purpose of this feature?
How this feature can automate my process?
What's the limit of this feature (the maximum things that I can do using Flows)
There are node limits that I can create / clone when I'm setup a Flow?
What's the difference between Flow and Single operation. Why use Flows instead of Operations?
Let's add FAQ's section here, CTA (Call to Actions) and linking between pages.
RafaelOsiro
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have a lot to change. Look carefully at each comment that has specific things for each page or each line.
In general, it's not just about separating the content, it has to make sense and also flow in a way that the user can understand.
Some things, such as permissions, should be informed instead of redirecting the user to the permissions page. This gives the user a bad impression. Sometimes they are in a hurry and want to know what needs to be done and what permission is required.
Some passages are written in a robotic and unnatural way. Perhaps you should write them yourself.
Look carefully, as there are links that require a new tab to be opened and others that may redirect the user.
RafaelOsiro
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, the changes are very good. We just need to improve a few minor details on the Overview page.
RafaelOsiro
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general, you just need to tweak a few Call to Action links. They sound a bit robotic.
Since there are three CTAs on the docs/flows/add-flow.md page, you can vary them one by one so they don't sound repetitive.
And there are a few typos that need to be fixed.
Overview
This PR restructured the flows user guide.
Key Changes