Update documentation (#128)

* Typo fixes * Other changes in documentation
masesgroup · Oct 20, 2023 · 38b845d · 38b845d
1 parent ec16600
commit 38b845d
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -48,7 +48,7 @@ This project adheres to the Contributor [Covenant code of conduct](CODE_OF_CONDU
 ## Summary
 
 * [Getting started](src/documentation/articles/gettingstarted.md)
-* [How works](src/documentation/articles/howitworks.md)
+* [How it works](src/documentation/articles/howitworks.md)
 * [Usage](src/documentation/articles/usage.md)
 * [Use cases](src/documentation/articles/usecases.md)
 * [Templates usage](src/documentation/articles/usageTemplates.md)

diff --git a/src/documentation/articles/currentstate.md b/src/documentation/articles/currentstate.md
@@ -4,5 +4,6 @@ The latest release implementes these features:
 
 * [x] A working provider based on Apache Kafka Streams
 * [x] The provider can use KNetCompactedReplicator
-* [x] An external package for serialization based on .NET 6 Json serializers
-* [x] An external package for serialization based on Apache Avro serializers
+* [x] A base package for serialization based on .NET Json serializers
+* [x] An external package for serialization based on Apache Avro serializers
+* [x] A package with some templates
diff --git a/src/documentation/articles/roadmap.md b/src/documentation/articles/roadmap.md
@@ -6,4 +6,5 @@ The roadmap can be synthetized in the following points:
 * [ ] Extends the first provider with new features able to create Apache Kafka Streams topology to retrieve information
 * [x] Use KNetCompactedReplicator beside Apache Kafka Streams
 * [x] Add external package to manage data serialization
-* [x] Add Avro external package to manage data serialization
+* [x] Add Avro external package to manage data serialization
+* [x] Add Templates package
diff --git a/src/documentation/articles/toc.yml b/src/documentation/articles/toc.yml
@@ -2,7 +2,7 @@
   href: intro.md
 - name: Getting started
   href: gettingstarted.md
-- name: How works
+- name: How it works
   href: howitworks.md
 - name: Usage
   href: usage.md

diff --git a/src/documentation/articles/usecases.md b/src/documentation/articles/usecases.md
@@ -1,7 +1,7 @@
 # KEFCore: use cases
 
 [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/) can be used in some operative conditions.
-Here a possible, non exausthive list, of use cases.
+Here a possible, non exhaustive list, of use cases.
 
 Before read following chapters it is important to understand [how it works](howitworks.md).
 

diff --git a/src/documentation/index.md b/src/documentation/index.md
@@ -42,7 +42,7 @@ This project adheres to the Contributor [Covenant code of conduct](CODE_OF_CONDU
 ## Summary
 
 * [Getting started](articles/gettingstarted.md)
-* [How works](articles/howitworks.md)
+* [How it works](articles/howitworks.md)
 * [Usage](articles/usage.md)
 * [Use cases](articles/usecases.md)
 * [Templates usage](articles/usageTemplates.md)