Skip to content

Commit d267c6a

Browse files
craigfowlercraigfowler
committed
Update docs homepage
1 parent faf4578 commit d267c6a

3 files changed

Lines changed: 91 additions & 25 deletions

File tree

‎CSF.Validation.Documentation/index.md‎

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,42 @@
33
**CSF.Validation** is a framework [for validating domain objects].
44
Its goal is to provide an extensible architecture for writing, executing and consuming the results of validation logic.
55

6-
[for validating domain objects]:articles/WhatIsDomainObjectValidation.md
6+
The [documentation home page] links to tutorials, examples & guidance for writing validators.
7+
The source code is hosted on a [GitHub project site].
8+
Please visit to contribute issue reports, changes, discussion or to see the project status.
79

8-
## Tutorials & documentation
10+
[for validating domain objects]:articles/WhatIsDomainObjectValidation.md
11+
[documentation home page]:articles/index.md
12+
[GitHub project site]:https://github.com/csf-dev/CSF.Validation
913

10-
The [documentation introduction page] lists the three main steps to creating a working validator, with links to further detail.
14+
## Compatibility
1115

12-
[documentation introduction page]:articles/index.md
16+
The CSF.Validation NuGet packages are _multi-targeted_ for a wide-range of supported .NET versions.
17+
This table shows the .NET support.
1318

14-
## Source code, status & issue reports
19+
| Runtime | Versions |
20+
| ------- | ----------- |
21+
| .NET Framework | **4.6.1** and up |
22+
| .NET Core | **2.0** and up |
23+
| .NET | **5.0** and up |
1524

16-
For the source code, to contribute changes or issue reports and to see the current project status, you are encouraged to visit the [GitHub project site].
25+
## NuGet packages
1726

18-
[GitHub project site]:https://github.com/csf-dev/CSF.Validation
27+
The validation framework is distributed across a number of packages available via NuGet.
28+
This table summarises each of them and their purpose.
1929

20-
## Compatibility
30+
| Package | Description |
31+
| ------- | ---------- |
32+
| [CSF.Validation.Abstractions] | Models & interfaces required to consume validation from your application's logic using dependency injection. Has minimal/no dependencies of its own (depending upon target framework). |
33+
| [CSF.Validation] | The core logic of the validation framework. Only needs to be referenced by an application's startup project to configure dependency injection. |
34+
| [CSF.Validation.StandardRules] | Pre-written validation rules & messages. Also a service to validate a validation manifest. Has minimal dependencies of its own. |
35+
| [CSF.Validation.Json] | A serializer service for reading/writing [manifest models] to/from JSON, demonstrating _validation as data_. |
36+
| [CSF.Validation.Selfhosting] | A library enabling use of the validation framework by apps which do not use dependency injection. |
2137

22-
The CSF.Validation NuGet packages are multi-targeted for **.NET Standard 2.0** & **.NET Framework 4.6.1**.
23-
This means that it supports all of the following target frameworks (amongst others):
2438

25-
* .NET Framework v4.6.1 or higher
26-
* .NET Core v2.0 or higher
27-
* .NET v5.0 or higher
39+
[CSF.Validation.Abstractions]: https://www.nuget.org/packages/CSF.Validation.Abstractions/
40+
[CSF.Validation]: https://www.nuget.org/packages/CSF.Validation/
41+
[CSF.Validation.StandardRules]: https://www.nuget.org/packages/CSF.Validation.StandardRules/
42+
[CSF.Validation.Json]: https://www.nuget.org/packages/CSF.Validation.Json/
43+
[CSF.Validation.Selfhosting]: https://www.nuget.org/packages/CSF.Validation.Selfhosting/
44+
[manifest models]: xref:ManifestModelIndexPage

‎docs/_vnext/index.html‎

Lines changed: 60 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -71,18 +71,67 @@ <h1 id="validation-framework">Validation framework</h1>
7171

7272
<p><strong>CSF.Validation</strong> is a framework <a href="articles/WhatIsDomainObjectValidation.html">for validating domain objects</a>.
7373
Its goal is to provide an extensible architecture for writing, executing and consuming the results of validation logic.</p>
74-
<h2 id="tutorials--documentation">Tutorials &amp; documentation</h2>
75-
<p>The <a href="articles/index.html">documentation introduction page</a> lists the three main steps to creating a working validator, with links to further detail.</p>
76-
<h2 id="source-code-status--issue-reports">Source code, status &amp; issue reports</h2>
77-
<p>For the source code, to contribute changes or issue reports and to see the current project status, you are encouraged to visit the <a href="https://github.com/csf-dev/CSF.Validation">GitHub project site</a>.</p>
74+
<p>The <a href="articles/index.html">documentation home page</a> links to tutorials, examples &amp; guidance for writing validators.
75+
The source code is hosted on a <a href="https://github.com/csf-dev/CSF.Validation">GitHub project site</a>.
76+
Please visit to contribute issue reports, changes, discussion or to see the project status.</p>
7877
<h2 id="compatibility">Compatibility</h2>
79-
<p>The CSF.Validation NuGet packages are multi-targeted for <strong>.NET Standard 2.0</strong> &amp; <strong>.NET Framework 4.6.1</strong>.
80-
This means that it supports all of the following target frameworks (amongst others):</p>
81-
<ul>
82-
<li>.NET Framework v4.6.1 or higher</li>
83-
<li>.NET Core v2.0 or higher</li>
84-
<li>.NET v5.0 or higher</li>
85-
</ul>
78+
<p>The CSF.Validation NuGet packages are <em>multi-targeted</em> for a wide-range of supported .NET versions.
79+
This table shows the .NET support.</p>
80+
<table>
81+
<thead>
82+
<tr>
83+
<th>Runtime</th>
84+
<th>Versions</th>
85+
</tr>
86+
</thead>
87+
<tbody>
88+
<tr>
89+
<td>.NET Framework</td>
90+
<td><strong>4.6.1</strong> and up</td>
91+
</tr>
92+
<tr>
93+
<td>.NET Core</td>
94+
<td><strong>2.0</strong> and up</td>
95+
</tr>
96+
<tr>
97+
<td>.NET</td>
98+
<td><strong>5.0</strong> and up</td>
99+
</tr>
100+
</tbody>
101+
</table>
102+
<h2 id="nuget-packages">NuGet packages</h2>
103+
<p>The validation framework is distributed across a number of packages available via NuGet.
104+
This table summarises each of them and their purpose.</p>
105+
<table>
106+
<thead>
107+
<tr>
108+
<th>Package</th>
109+
<th>Description</th>
110+
</tr>
111+
</thead>
112+
<tbody>
113+
<tr>
114+
<td><a href="https://www.nuget.org/packages/CSF.Validation.Abstractions/">CSF.Validation.Abstractions</a></td>
115+
<td>Models &amp; interfaces required to consume validation from your application's logic using dependency injection. Has minimal/no dependencies of its own (depending upon target framework).</td>
116+
</tr>
117+
<tr>
118+
<td><a href="https://www.nuget.org/packages/CSF.Validation/">CSF.Validation</a></td>
119+
<td>The core logic of the validation framework. Only needs to be referenced by an application's startup project to configure dependency injection.</td>
120+
</tr>
121+
<tr>
122+
<td><a href="https://www.nuget.org/packages/CSF.Validation.StandardRules/">CSF.Validation.StandardRules</a></td>
123+
<td>Pre-written validation rules &amp; messages. Also a service to validate a validation manifest. Has minimal dependencies of its own.</td>
124+
</tr>
125+
<tr>
126+
<td><a href="https://www.nuget.org/packages/CSF.Validation.Json/">CSF.Validation.Json</a></td>
127+
<td>A serializer service for reading/writing <a class="xref" href="articles/WritingValidators/UsingTheManifestModel/index.html">manifest models</a> to/from JSON, demonstrating <em>validation as data</em>.</td>
128+
</tr>
129+
<tr>
130+
<td><a href="https://www.nuget.org/packages/CSF.Validation.Selfhosting/">CSF.Validation.Selfhosting</a></td>
131+
<td>A library enabling use of the validation framework by apps which do not use dependency injection.</td>
132+
</tr>
133+
</tbody>
134+
</table>
86135
</article>
87136
</div>
88137

‎docs/_vnext/manifest.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3981,7 +3981,7 @@
39813981
"output": {
39823982
".html": {
39833983
"relative_path": "index.html",
3984-
"hash": "0hNUdzMjxodUOCm/tzMIPaZC+K3wX3R1iQ9Dy0iYJyo="
3984+
"hash": "nm3hvrt6w9iJHAOVksQ8Rx81g6MZ57kDEEyiOJyAcY0="
39853985
}
39863986
},
39873987
"is_incremental": false,

0 commit comments

Comments
 (0)