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 65c0eb2 commit 5a58dbe
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/site/Writerside/topics/discussions/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ Please see the [performance metrics](Performance.md) for more 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.
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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,6 @@ From what I've read, it's not recommended to share the DB Context across threads
Yes, it's more code, but it's explicit.

<note title="Users' tips">
<a href="efcore-tips.md">This page</a> has some handy tips provided by the community.
<a href="efcore-tips.md" summary="Handy tips for working with EF Core">This page</a> has some handy tips provided by the community.

</note>
6 changes: 3 additions & 3 deletions docs/site/Writerside/topics/reference/Performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ This topic is incomplete and is currently being improved.

(to run these yourself: `dotnet run -c Release --framework net8.0 -- --job short --filter *` in the `Vogen.Benchmarks` folder)

As mentioned previously, the goal of Vogen is to achieve very similar performance compared to using primitives themselves.
Here's a benchmark comparing the use of a validated Value Object with an underlying type of `int` vs. using an `int` natively (*primitively* 🤓)
As mentioned previously, the goal of Vogen is to achieve similar performance compared to using primitives themselves.
Here's a benchmark comparing a validated Value Object with an underlying type of `int` vs. using an `int` natively (*primitively* 🤓)

``` ini
BenchmarkDotNet=v0.13.2, OS=Windows 11 (10.0.22621.1194)
Expand Down Expand Up @@ -45,4 +45,4 @@ WarmupCount=3
| UsingValueObjectAsStruct | 184.8 ns | 12.19 | 0.67 | 1.22 | 0.02 | 0.0153 | 256 B | 1.00 |


There is a tiny amount of performance overhead, but these measurements are incredibly small. There is no memory overhead.
There's a minor performance overhead, but these measurements are incredibly small. Also, there's no memory overhead.
2 changes: 1 addition & 1 deletion docs/site/Writerside/writerside.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@

<ihp version="2.0">
<topics dir="topics" web-path="topics"/>
<images dir="images" web-path="/hi/"/>
<images dir="images" web-path="/hi/images"/>
<instance src="hi.tree"/>
</ihp>

0 comments on commit 5a58dbe

Please sign in to comment.