From 6cd13c6317fbe78fe042207a253e01bf754ff8ad Mon Sep 17 00:00:00 2001 From: dvolper Date: Sat, 22 Jun 2024 23:05:51 +0200 Subject: [PATCH 1/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 75219db..bce10ce 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ # doki -Doki is a .NET code documentation framework that allows you to generate documentation from your codebase. +Doki is a [.NET](https://dot.net) code documentation framework that allows you to generate documentation from your codebase. It uses the XML documentation comments in your code to generate documentation in various formats, such as Markdown, JSON, and more. From 5b5e6e5ab56604a85b891fecd729c14d80c13f11 Mon Sep 17 00:00:00 2001 From: dvolper Date: Sat, 22 Jun 2024 23:06:44 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bce10ce..e4cf033 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Doki is a [.NET](https://dot.net) code documentation framework that allows you to generate documentation from your codebase. -It uses the XML documentation comments in your code to generate documentation in various formats, such as Markdown, +It uses the [XML documentation comments](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc) in your code to generate documentation in various formats, such as Markdown, JSON, and more. ## Getting Started