Skip to content

Commit 30a32f3

Browse files
Merge pull request #612 from lincolnarrais/patch-2
Suggestions that I think may improve documentation just a little bit. /docs/intro/
2 parents d9d8ce0 + 3e5b530 commit 30a32f3

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

doc/docs/intro.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@ Let's find out how to implement a Modular structure in your project.
88

99
## What is Modular?
1010

11-
The Modular proposes to solve two problems:
11+
Modular proposes to solve two problems:
1212
- Modularized routes.
1313
- Modularized Dependency Injection.
1414

15-
In a monolithic, where we have our entire application as a single module, we design our software quickly and
16-
elegant taking advantage of all the amazing features of Flutter💙. However, producing a larger app in a "monolithic" way
17-
can generate technical debt in both maintenance and scalability. With this in mind, the developers adopted architectural strategies to better divide the code, minimizing the negative impacts on the project's maintainability and scalability..
15+
In a monolithic architecture, where we have our entire application as a single module, we design our software in a quick and
16+
elegant way, taking advantage of all the amazing features of Flutter💙. However, producing a larger app in a "monolithic" way
17+
can generate technical debt in both maintanance and scalability. With this in mind, developers adopted architectural strategies to better divide the code, minimizing the negative impacts on the project's maintainability and scalability..
1818

1919
By better dividing the scope of features, we gain:
2020

2121
- Improved understanding of features.
22-
- Less break changes.
22+
- Less breaking changes.
2323
- Add new non-conflicting features.
2424
- Less blind spots in the project's main business rule.
2525
- Improved developer turnover.
2626

27-
With the most readable code, we extend the life of the project. See example of a standard MVC with 3 features(Auth, Home, Product):
27+
With a more readable code, we extend the life of the project. See example of a standard MVC with 3 features(Auth, Home, Product):
2828

2929
### A typical MVC
3030

@@ -75,17 +75,17 @@ Let's see how the structure looks when we divide by scope:
7575

7676
What we did in this structure was to continue using MVC, but this time in scope. This means that
7777
each feature has its own MVC, and this simple approach solves many scalability and maintainability issues.
78-
We call this approach "Smart Structure". There were still two things that were Global and that clashed with the structure itself and so we created Modular to solve this impasse.
78+
We call this approach "Smart Structure". But two things were still Global and clashed with the structure itself, so we created Modular to solve this impasse.
7979

8080
In short: Modular is a solution to modularize the route and dependency injection system, making each scope have
8181
its own routes and injections independent of any other factor in the structure.
82-
We create an object to group the Routes and Injections and call it **Modules**.
82+
We create objects to group the Routes and Injections and call them **Modules**.
8383

8484

8585

8686
## Ready to get started?
8787

88-
Modular is not only ingenious for doing something amazing like componentizing Routes and Dependency Injections, it's amazing.
88+
Modular is not only ingenious for doing something amazing like componentizing Routes and Dependency Injections, it's amazing
8989
for being able to do all this simply!
9090

9191
Go to the next topic and start your journey towards an intelligent structure.
@@ -94,15 +94,15 @@ Go to the next topic and start your journey towards an intelligent structure.
9494

9595
- Does Modular work with any state management approach?
9696
- Yes, the dependency injection system is agnostic to any kind of class
97-
including the reactivity that make up state management.
97+
including the reactivity that makes up state management.
9898

9999
- Can I use dynamic routes or Wildcards?
100100
- Yes! The entire route tree responds as on the Web. Therefore, you can use dynamic parameters,
101101
query, fragments or simply include a wildcard to enable a redirect
102102
to a 404 page for example.
103103

104104
- Do I need to create a Module for all features?
105-
- No. You can create a module only when you think it's necessary or when the feature is no longer a part
106-
the scope in which it is being worked.
105+
- No. You can create a module only when you think it's necessary or when the feature is no longer a part of
106+
the scope in which it is being worked on.
107107

108108

0 commit comments

Comments
 (0)