Skip to content

Conversation

@iammuze
Copy link
Collaborator

@iammuze iammuze commented Sep 29, 2025

Overview

This PR restructured the flows user guide.

Key Changes

  • Restructured: userguide

@iammuze iammuze requested a review from RafaelOsiro September 29, 2025 11:36
@iammuze iammuze self-assigned this Sep 29, 2025
@iammuze iammuze added the documentation Improvements or additions to documentation label Sep 29, 2025
Copy link
Contributor

@RafaelOsiro RafaelOsiro left a 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.

@iammuze iammuze requested a review from RafaelOsiro October 7, 2025 09:46
@RafaelOsiro RafaelOsiro changed the title QUA:933- Refactor " Flows" userguide. QUA-933: Refactor " Flows" userguide. Oct 16, 2025
@RafaelOsiro RafaelOsiro changed the title QUA-933: Refactor " Flows" userguide. QUA-993: Refactor " Flows" userguide. Oct 24, 2025
Copy link
Contributor

@RafaelOsiro RafaelOsiro left a 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.

@iammuze iammuze requested a review from RafaelOsiro November 14, 2025 15:55
Copy link
Contributor

@RafaelOsiro RafaelOsiro left a 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.

@iammuze iammuze requested a review from RafaelOsiro November 19, 2025 08:19
Copy link
Contributor

@RafaelOsiro RafaelOsiro left a 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.

@iammuze iammuze requested a review from RafaelOsiro November 25, 2025 05:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants