Skip to content

Commit a5afe58

Browse files
committed
docs: fix ortographic and gramatical errors
1 parent ec5c86b commit a5afe58

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

ARCHITECTURE.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Standard Design and Architecture
22

3-
At the time of writing, almost a year of exploratory and freestyle project history has past.
3+
At the time of writing, almost a year of exploratory and freestyle project history has passed.
44
Fortunately, it is not necessary for further understanding, so I'll spare you that.
55
This document, though, lays out the design, architecture and direction of Standard.
66

@@ -17,9 +17,9 @@ In particular, Standard is a _Horizontal Integration Framework_ which integrates
1717
>
1818
> _Vertical Tooling_ does one thing and does it well in a narrow scope (i.e "vertical").
1919
>
20-
> _Horizontal Tooling_ stiches vertical tooling together to a polished whole.
20+
> _Horizontal Tooling_ stitches vertical tooling together to a polished whole.
2121
22-
In that context, the integration target are the end-to-end automatable sections of the SDLC process for which we offer well-integrated tools and best practices.
22+
In that context, the integration targets are the end-to-end automatable sections of the SDLC process for which we offer well-integrated tools and best practices.
2323
_Efficient_ SDLCs are characterized by two things.
2424

2525
Firstly, by adequate _lead time_ which is the amount of time it takes to set up an initial version of the software delivery pipeline.
@@ -31,7 +31,7 @@ Along this journey, we encounter our scope (more on it below):
3131

3232
- aspects of the _contribution_ environment;
3333
- the packaging pipeline that produces artifacts;
34-
- and continous processes integrating the application lifecycle.
34+
- and continuous processes integrating the application lifecycle.
3535

3636
The goal of Standard is to optimize the critical path along this journey to achieve superior _cycle times_ through the powers of Nix and Flakes over frameworks in failure mode of disregard for the intrinsic value of _reproducability_.
3737

@@ -49,7 +49,7 @@ The stipulated process regions are:
4949
>
5050
> We use the term _Contribution Environment_ to mean _Development Environment Plus_.
5151
> Compared to _Development Environment_, it explicitly encapsulates aspects of contribution and integration of the broader process flow.
52-
> If you prefer, you can think _Development Environment_ for practical purposes.
52+
> If you prefer, you can think of _Development Environment_ for practical purposes.
5353
5454
While Standard is fundamentally concerned with optimizing across the end-to-end process, we also limit the scope inside this project repository for practical reasons:
5555

@@ -67,8 +67,8 @@ The project is rooted deeply inside the Nix Ecosystem, but it strives to become
6767

6868
## Goals
6969

70-
- _Complete_: Standard should make a complete offer for setting up and running the automatbale sections of the SDLC.
71-
- _Optimized_: Standard should optimize for agent ("make your day-to-day life easier") and principle ("quick time-to-market"), alike.
70+
- _Complete_: Standard should make a complete offer for setting up and running the automatable sections of the SDLC.
71+
- _Optimized_: Standard should optimize for agents ("make your day-to-day life easier") and principle ("quick time-to-market"), alike.
7272
- _Integrated_: Standard should provide the best possible integration experience across a well-curated assortment of verticals.
7373

7474
## Value Matrix
@@ -88,14 +88,14 @@ The X-Axis represents the three prototypical stakeholder roles, while the Y-Axis
8888
| Code Organization | :smiley: | :heart_eyes: | :smiley: |
8989
| Mental Model & Learning | :smiley: | :heart_eyes: | :smiley: |
9090
| Batteries Included | :neutral_face: | :heart_eyes: | :neutral_face: |
91-
| Communtiy and Ecosystem | :neutral_face: | :heart_eyes: | :smiley: |
92-
| Reproducability & Software Supply Chain Security | :heart_eyes: | :heart_eyes: | :neutral_face: |
91+
| Community and Ecosystem | :neutral_face: | :heart_eyes: | :smiley: |
92+
| Reproducibility & Software Supply Chain Security | :heart_eyes: | :heart_eyes: | :neutral_face: |
9393
| Modularity & Incremental Adoption | :smiley: | :smiley: | :heart_eyes: |
9494
| Developer Experience & Onboarding Story | :smiley: | :smiley: | :heart_eyes: |
9595

9696
So, this is for you and your team, if you:
9797

98-
- Care about reproducability
98+
- Care about reproducibility
9999
- Value clean code
100100
- Have a deadline to meet
101101
- Want to serve an optimized UX
@@ -109,7 +109,7 @@ So, this is for you and your team, if you:
109109

110110
### Code Organization
111111

112-
Standard is build around a balanced model of code organization that promotes transparency, the ability to refactor and productivity.
112+
Standard is built around a balanced model of code organization that promotes transparency, the ability to refactor and productivity.
113113
This code organization is provided by a so-called "Importer Library" housed as an independently useful component under [`divnix/paisano`](https://github.com/divnix/paisano).
114114

115115
It features three principles:
@@ -135,7 +135,7 @@ The last principle opens up a realm of possibilities from user interfaces to pip
135135

136136
### Function Library
137137

138-
Alongside the **Packaging Pipeline**, and by dogfooding its code organization principles, Standard provides a curated assortment of library functions and integrations that users can adopt in accordance with their needs encouraged by the promise of hightened productivity or the peace of mind to build on the shoulders of the entire Standard community.
138+
Alongside the **Packaging Pipeline**, and by dogfooding its code organization principles, Standard provides a curated assortment of library functions and integrations that users can adopt in accordance with their needs encouraged by the promise of heightened productivity or the peace of mind to build on the shoulders of the entire Standard community.
139139
Some library functions and integrations may be assorted outside of these organizational principles as otherwise unspecial top level shorthands.
140140

141141
### Block Type Library
@@ -150,4 +150,4 @@ As another example, it would be redundant to encode deployment semantics of a te
150150
Within the scope of the Standard use case, we aim to provide registry-like features to index community provided block types and library functions that are not maintained by the core maintainers.
151151
Such a registry will need to find a good solution for near-code documentation that can be rendered into a compelling index and documentation site.
152152

153-
Strictly, this model may be useful outside of Standard in the context of paisano, but in here that's also not Standard's problem.
153+
Strictly, this model may be useful outside of Standard in the context of paisano, but here that's also not Standard's problem.

0 commit comments

Comments
 (0)