You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ARCHITECTURE.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Standard Design and Architecture
2
2
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.
4
4
Fortunately, it is not necessary for further understanding, so I'll spare you that.
5
5
This document, though, lays out the design, architecture and direction of Standard.
6
6
@@ -17,9 +17,9 @@ In particular, Standard is a _Horizontal Integration Framework_ which integrates
17
17
>
18
18
> _Vertical Tooling_ does one thing and does it well in a narrow scope (i.e "vertical").
19
19
>
20
-
> _Horizontal Tooling_stiches vertical tooling together to a polished whole.
20
+
> _Horizontal Tooling_stitches vertical tooling together to a polished whole.
21
21
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.
23
23
_Efficient_ SDLCs are characterized by two things.
24
24
25
25
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):
31
31
32
32
- aspects of the _contribution_ environment;
33
33
- the packaging pipeline that produces artifacts;
34
-
- and continous processes integrating the application lifecycle.
34
+
- and continuous processes integrating the application lifecycle.
35
35
36
36
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_.
37
37
@@ -49,7 +49,7 @@ The stipulated process regions are:
49
49
>
50
50
> We use the term _Contribution Environment_ to mean _Development Environment Plus_.
51
51
> 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.
53
53
54
54
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:
55
55
@@ -67,8 +67,8 @@ The project is rooted deeply inside the Nix Ecosystem, but it strives to become
67
67
68
68
## Goals
69
69
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.
72
72
-_Integrated_: Standard should provide the best possible integration experience across a well-curated assortment of verticals.
73
73
74
74
## Value Matrix
@@ -88,14 +88,14 @@ The X-Axis represents the three prototypical stakeholder roles, while the Y-Axis
| Developer Experience & Onboarding Story |:smiley:|:smiley:|:heart_eyes:|
95
95
96
96
So, this is for you and your team, if you:
97
97
98
-
- Care about reproducability
98
+
- Care about reproducibility
99
99
- Value clean code
100
100
- Have a deadline to meet
101
101
- Want to serve an optimized UX
@@ -109,7 +109,7 @@ So, this is for you and your team, if you:
109
109
110
110
### Code Organization
111
111
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.
113
113
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).
114
114
115
115
It features three principles:
@@ -135,7 +135,7 @@ The last principle opens up a realm of possibilities from user interfaces to pip
135
135
136
136
### Function Library
137
137
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.
139
139
Some library functions and integrations may be assorted outside of these organizational principles as otherwise unspecial top level shorthands.
140
140
141
141
### Block Type Library
@@ -150,4 +150,4 @@ As another example, it would be redundant to encode deployment semantics of a te
150
150
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.
151
151
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.
152
152
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