docs: Add Reference documentation (#114)

* docs: Add Reference documentation * docs: Add submodule
NikiforovAll · Jun 3, 2024 · 5445167 · 5445167
1 parent 69cc022
commit 5445167
Show file tree

Hide file tree

Showing 9 changed files with 53 additions and 10 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "docs-reference"]
+	path = docs-reference
+	url = https://github.com/NikiforovAll/keycloak-authorization-services-dotnet-docs
diff --git a/README.md b/README.md
@@ -24,7 +24,11 @@ Easy Authentication and Authorization with Keycloak in .NET.
 
 ## Documentation
 
-See the docs: <https://nikiforovall.github.io/keycloak-authorization-services-dotnet>
+For Developer Documentation see: <https://nikiforovall.github.io/keycloak-authorization-services-dotnet>
+
+### API Reference
+
+See: <https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs>
 
 ## Getting Started
 

diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -17,8 +17,9 @@ export default withMermaid({
         nav: [
             { text: 'Home', link: '/' },
             { text: 'Getting Started', link: '/introduction' },
-            { text: 'Migration', link: '/migration' },
             { text: 'Examples', link: 'examples/auth-getting-started' },
+            { text: 'Migration', link: '/migration' },
+            { text: 'API Reference', link: 'https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs/' },
             { text: 'Blog', link: 'blogs' },
             { text: 'Join Chat', link: 'https://discord.gg/S449PhBPRQ' },
         ],

diff --git a/docs/admin-rest-api/admin-api-kiota.md b/docs/admin-rest-api/admin-api-kiota.md
@@ -2,13 +2,18 @@
 
 This `KeycloakAdminApiClient` was generated using the *Kiota* library.
 
-```bash
-dotnet add package Keycloak.AuthServices.Sdk.Kiota
-```
+> [!TIP]
+> API Reference: [Keycloak.AuthServices.Sdk.Kiota](https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs/api-reference/Keycloak.AuthServices.Sdk.Kiota.ServiceCollectionExtensions.html)
 
 > [!NOTE]
 > Kiota is a powerful command line tool developed by Microsoft that simplifies the process of generating API clients for calling any OpenAPI-described API. See [OpenAPI Support](/admin-rest-api/admin-api-openapi) for more details.
 
+## Getting Started
+
+```bash
+dotnet add package Keycloak.AuthServices.Sdk.Kiota
+```
+
 ```csharp
 /// <summary>
 /// Adds <see cref="KeycloakAdminApiClient"/> for Keycloak Admin API.

diff --git a/docs/admin-rest-api/group-client.md b/docs/admin-rest-api/group-client.md
@@ -1,3 +1,9 @@
-# IKeycloakGroupClient
+# API Reference - IKeycloakGroupClient
+
+API Reference docs: [Keycloak.AuthServices.Sdk.Admin.IKeycloakGroupClient](https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs/api-reference/Keycloak.AuthServices.Sdk.Admin.IKeycloakGroupClient.html)
+
+::: details IKeycloakGroupClient.cs
 
 <<< @/../src/Keycloak.AuthServices.Sdk/Admin/IKeycloakGroupClient.cs
+
+:::
diff --git a/docs/admin-rest-api/realm-client.md b/docs/admin-rest-api/realm-client.md
@@ -1,3 +1,9 @@
-# IKeycloakRealmClient
+# API Reference - IKeycloakRealmClient
+
+API Reference docs: [Keycloak.AuthServices.Sdk.Admin.IKeycloakRealmClient](https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs/api-reference/Keycloak.AuthServices.Sdk.Admin.IKeycloakRealmClient.html)
+
+::: details IKeycloakRealmClient.cs
 
 <<< @/../src/Keycloak.AuthServices.Sdk/Admin/IKeycloakRealmClient.cs
+
+:::
diff --git a/docs/admin-rest-api/user-client.md b/docs/admin-rest-api/user-client.md
@@ -1,3 +1,9 @@
-# IKeycloakUserClient
+# API Reference - IKeycloakUserClient
+
+API Reference docs: [Keycloak.AuthServices.Sdk.Admin.IKeycloakUserClient](https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs/api-reference/Keycloak.AuthServices.Sdk.Admin.IKeycloakUserClient.html)
+
+::: details IKeycloakUserClient.cs
 
 <<< @/../src/Keycloak.AuthServices.Sdk/Admin/IKeycloakUserClient.cs
+
+:::
diff --git a/docs/authorization/resources-client-reference.md b/docs/authorization/resources-client-reference.md
@@ -1,3 +1,9 @@
-# IAuthorizationServerClient
+# API Reference - IAuthorizationServerClient
+
+API Reference docs: [Keycloak.AuthServices.Authorization.AuthorizationServer.IAuthorizationServerClient](https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs/api-reference/Keycloak.AuthServices.Authorization.AuthorizationServer.IAuthorizationServerClient.html)
+
+::: details IAuthorizationServerClient.cs
 
 <<< @/../src/Keycloak.AuthServices.Authorization/AuthorizationServer/IAuthorizationServerClient.cs
+
+:::
diff --git a/docs/protection-api/protected-resource-client.md b/docs/protection-api/protected-resource-client.md
@@ -1,3 +1,9 @@
-# IKeycloakProtectedResourceClient
+# API Reference - IKeycloakProtectedResourceClient
+
+API Reference docs: [Keycloak.AuthServices.Sdk.Protection.IKeycloakProtectedResourceClient](https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs/api-reference/Keycloak.AuthServices.Sdk.Protection.IKeycloakProtectedResourceClient.html)
+
+::: details IKeycloakProtectedResourceClient.cs
 
 <<< @/../src/Keycloak.AuthServices.Sdk/Protection/IKeycloakProtectedResourceClient.cs
+
+:::