From 65c0eb25fde34d407296fe74ce9763c9706a0894 Mon Sep 17 00:00:00 2001 From: Steve Dunn Date: Mon, 29 Apr 2024 11:13:22 +0100 Subject: [PATCH] Updated docs --- docs/site/Writerside/topics/Vogen.md | 17 ---------------- .../Writerside/topics/discussions/Overview.md | 20 +++++++++++++++++++ .../Writerside/topics/reference/Hoisting.md | 2 +- 3 files changed, 21 insertions(+), 18 deletions(-) delete mode 100644 docs/site/Writerside/topics/Vogen.md diff --git a/docs/site/Writerside/topics/Vogen.md b/docs/site/Writerside/topics/Vogen.md deleted file mode 100644 index b5f37953c2..0000000000 --- a/docs/site/Writerside/topics/Vogen.md +++ /dev/null @@ -1,17 +0,0 @@ - -![image](https://user-images.githubusercontent.com/263416/178356159-02c7959c-b1e1-4ce5-9964-ae2751f0e641.png) - - -How this documentation is organized: - -Tutorials—take you by the hand through a series of steps to create an application that uses Vogen. -Start here if you’re new to Vogen. - -Topic guides—discuss key topics and concepts at a fairly high level and provide useful background information -and explanation. - -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 guides—recipes 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. \ No newline at end of file diff --git a/docs/site/Writerside/topics/discussions/Overview.md b/docs/site/Writerside/topics/discussions/Overview.md index 160504ad0b..4442f149e7 100644 --- a/docs/site/Writerside/topics/discussions/Overview.md +++ b/docs/site/Writerside/topics/discussions/Overview.md @@ -1,5 +1,9 @@ # Overview +

+cavey-logo.png +

+ [Vogen](https://github.com/SteveDunn/Vogen) wraps .NET primitives. You provide this: ``` c# @@ -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. + +* Tutorials—take you by the hand through a series of steps to create an application that uses Vogen. + Start here if you’re 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 guides—recipes 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 diff --git a/docs/site/Writerside/topics/reference/Hoisting.md b/docs/site/Writerside/topics/reference/Hoisting.md index 1fa032407e..cc1fecc3f5 100644 --- a/docs/site/Writerside/topics/reference/Hoisting.md +++ b/docs/site/Writerside/topics/reference/Hoisting.md @@ -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