Update docs (#595)

[nats:update-docs]
nats-io · Aug 6, 2024 · 41b1778 · 41b1778
1 parent c3f7e7a
commit 41b1778
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 12 deletions.
diff --git a/docs/docfx.json b/docs/docfx.json
@@ -52,10 +52,14 @@
     "postProcessors": [],
     "keepFileLink": false,
     "disableGitFeatures": false,
-    "sitemap": {
-      "baseUrl": "https://nats-io.github.io/nats.net.v2",
-      "priority": 0.1,
-      "changefreq": "monthly"
+    "markdownEngineName": "markdig",
+    "markdownEngineProperties": {
+        "markdigExtensions": [
+            "abbreviations",
+            "definitionlists",
+            "tasklists",
+            "footnotes"
+        ]
     }
   }
 }
diff --git a/docs/documentation/update-docs.md b/docs/documentation/update-docs.md
@@ -5,7 +5,7 @@ view locally and submit a Pull Request to be included in this documentation site
 
 ## Running DocFX locally
 
-Clone the NATS.Net ([nats-io/nats.net.v2](https://github.com/nats-io/nats.net.v2)) repository, then run `docfx` local server to view this documentation site.
+Clone the NATS .NET ([nats-io/nats.net](https://github.com/nats-io/nats.net)) repository, then run `docfx` local server to view this documentation site.
 You mush have [DocFX installed](https://dotnet.github.io/docfx/):
 
 ```
@@ -14,7 +14,7 @@ dotnet tool update -g docfx
 
 Generate API documentation and run local server:
 ```
-$ git clone https://github.com/nats-io/nats.net.v2.git
-$ cd nats.net.v2/docs
+$ git clone https://github.com/nats-io/nats.net.git
+$ cd nats.net/docs
 $ docfx docfx.json --serve
 ```
diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,6 @@
-# Welcome to NATS.Net
+# Welcome to NATS .NET
 
-NATS.Net is an open source [NATS](https://nats.io) client library for modern [.NET](https://dot.net/). NATS.Net fully supports async programming,
+NATS .NET is an open source [NATS](https://nats.io) client library for modern [.NET](https://dot.net/). NATS .NET fully supports async programming,
 recent APIs like Span, IAsyncEnumerable, Channels and takes advantage of .NET's performance improvements while providing
 a pleasant developer experience.
 

diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -9,7 +9,7 @@
         <Company>CNCF</Company>
         <Authors>The NATS Authors</Authors>
         <Copyright>Copyright © The NATS Authors 2016-$([System.DateTime]::Now.ToString(yyyy))</Copyright>
-        <PackageProjectUrl>https://github.com/nats-io/nats.net.v2</PackageProjectUrl>
+        <PackageProjectUrl>https://github.com/nats-io/nats.net</PackageProjectUrl>
         <RepositoryUrl>$(PackageProjectUrl)</RepositoryUrl>
         <RepositoryType>git</RepositoryType>
         <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>

diff --git a/src/NATS.Client.Core/Commands/CommandWriter.cs b/src/NATS.Client.Core/Commands/CommandWriter.cs
@@ -26,7 +26,7 @@ internal sealed class CommandWriter : IAsyncDisposable
     private const int SendMemSize = 8520;
 
     // should be more than SendMemSize
-    // https://github.com/nats-io/nats.net.v2/pull/383#discussion_r1484344102
+    // https://github.com/nats-io/nats.net/pull/383#discussion_r1484344102
     private const int MinSegmentSize = 16384;
 
     private readonly ILogger<CommandWriter> _logger;

diff --git a/src/NATS.Client.Core/Commands/ProtocolWriter.cs b/src/NATS.Client.Core/Commands/ProtocolWriter.cs
@@ -184,7 +184,7 @@ public void WriteUnsubscribe(IBufferWriter<byte> writer, int sid, int? maxMessag
         writer.Advance(size);
     }
 
-    // optimization detailed here: https://github.com/nats-io/nats.net.v2/issues/320#issuecomment-1886165748
+    // optimization detailed here: https://github.com/nats-io/nats.net/issues/320#issuecomment-1886165748
     [MethodImpl(MethodImplOptions.NoInlining)]
     private static void ThrowOnUtf8FormatFail() => throw new NatsException("Can not format integer.");