Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SteveDunn committed Apr 29, 2024
1 parent 6beae1c commit 65c0eb2
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 18 deletions.
17 changes: 0 additions & 17 deletions docs/site/Writerside/topics/Vogen.md

This file was deleted.

20 changes: 20 additions & 0 deletions docs/site/Writerside/topics/discussions/Overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Overview

<p >
<img alt="cavey-logo.png" src="cavey-logo.png" width="296"/>
</p>

[Vogen](https://github.com/SteveDunn/Vogen) wraps .NET primitives. You provide this:

``` c#
Expand Down Expand Up @@ -141,6 +145,22 @@ Put another way, if your `decimal` primitive represents an Account Balance, then
is **extremely** low overhead of using an `AccountBalance` Value Object instead.
Please see the [performance metrics](Performance.md) for more information.


## How this documentation is organized

* These top level pages discuss key topics and concepts at a fairly high level and provide useful background information
and explanation.

* Tutorialstake you by the hand through a series of steps to create an application that uses Vogen.
Start here if youre new to Vogen.

* Reference guides-contains technical reference for Vogen usage, describing how it works and how to use it.
The Assumption is that you have a basic understanding of key concepts.

* How-to guidesrecipes guiding you through the steps involved in addressing key problems and use-cases.
They are more advanced than tutorials, and they assume some knowledge of how Vogen works.


## Attribution

I took inspiration from [Andrew Lock's](https://github.com/andrewlock) [StronglyTypedId](https://github.com/andrewlock/StronglyTypedId) and got some great ideas
Expand Down
2 changes: 1 addition & 1 deletion docs/site/Writerside/topics/reference/Hoisting.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Also, the `IParsable`
family of interfaces (including `ISpanParsable` and `IUtf8SpanParsable`)
that are **implemented publicly** by the primitive are hoisted.

Please see the [Parsing](../how-to/Parsing.md) documentation for more information.
Please see the [Parsing](Parsing.md) documentation for more information.

## IComparable

Expand Down

0 comments on commit 65c0eb2

Please sign in to comment.