Skip to content

Commit 1106e7b

Browse files
committed
added more docs
1 parent dcfd9d6 commit 1106e7b

2 files changed

Lines changed: 41 additions & 10 deletions

File tree

docs/.vitepress/theme/custom.css

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,3 +215,33 @@
215215
background-color: rgba(253, 244, 82, 0.08);
216216
color: var(--vp-c-brand-1);
217217
}
218+
219+
.principles {
220+
background: var(--vp-c-bg-soft);
221+
border: 1px solid var(--vp-c-border);
222+
border-radius: 12px;
223+
padding: 2rem;
224+
margin-top: 3rem;
225+
box-shadow: 0 4px 20px rgba(0, 0, 0, 0.05);
226+
}
227+
228+
.principles-title {
229+
font-size: 1.6rem;
230+
font-weight: 600;
231+
margin-bottom: 1.5rem;
232+
color: var(--vp-c-text-1);
233+
}
234+
235+
.principles-list {
236+
list-style: none;
237+
padding: 0;
238+
margin: 0;
239+
}
240+
241+
.principles-list-item {
242+
position: relative;
243+
padding-left: 0.5em;
244+
margin-bottom: 1rem;
245+
font-size: 1.15rem;
246+
color: var(--vp-c-text-2);
247+
}

docs/why.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ Robust Validator was born out of the need for a versatile data validation soluti
66

77
Why choose Robust Validator? It's more than just a data validation tool; it's a commitment to providing a reliable, well-maintained, and feature-rich solution for developers who value simplicity and effectiveness in their projects.
88

9-
## Principles
10-
11-
I decided on some fundamental rules while building this library:
12-
13-
- Every validation rule should be an independent function.
14-
- Every validation rule should be able to be used separately
15-
- All validation definition should be able to be stored anywhere (database, memory, configuration files, 3rd party API, etc) to be used later.
16-
- All validation rules should be able to be used in different languages.
17-
- Contribution to the rule set should be easy.
18-
- Should be well-documented.
9+
<section class="principles">
10+
<div class="principles-title">Design Principles</div>
11+
<div class="principles-list">
12+
<div class="principles-list-item">⚡ Each validation rule is a standalone function.</div>
13+
<div class="principles-list-item">⚡ Rules can be used on their own.</div>
14+
<div class="principles-list-item">⚡ Definitions can live anywhere such as database, config, memory, or API.</div>
15+
<div class="principles-list-item">⚡ Every rule supports multiple languages out of the box.</div>
16+
<div class="principles-list-item">⚡ Adding new rules is simple and straightforward.</div>
17+
<div class="principles-list-item">⚡ Everything is clearly and practically documented.</div>
18+
</div>
19+
</section>

0 commit comments

Comments
 (0)