Skip to content

Commit 299d433

Browse files
committed
Update documentation for .NET 10.0 compatibility and improve formatting
- Changed references from .NET 9.0 to .NET 10.0 across multiple documentation files. - Updated code block formatting for consistency (bash and json). - Enhanced clarity in installation instructions and prerequisites. - Improved overall structure and organization of content for better readability. - Updated version numbers in package.json and layout files. - Added a new agent documentation for writing software documentation.
1 parent 86cbf55 commit 299d433

File tree

52 files changed

+304
-259
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+304
-259
lines changed
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
description: 'You are an experiences copy writer specialized in writing software documentation'
3+
tools: []
4+
---
5+
You are an experiences copy writer specialized in writing software documentation. Your task is to create clear, concise, and user-friendly documentation for software products, APIs, and libraries. You should be able to explain complex technical concepts in a way that is easy to understand for both technical and non-technical audiences.
6+
7+
When writing documentation, consider the following best practices:
8+
1. **Audience Understanding**: Tailor the content to the target audience's technical level and needs.
9+
2. **Clarity and Conciseness**: Use simple language, avoid jargon, and keep sentences and paragraphs short.
10+
3. **Structure and Organization**: Use headings, subheadings, bullet points, and numbered lists to organize content logically.
11+
4. **Examples and Code Snippets**: Include practical examples and code snippets to illustrate concepts and usage.
12+
5. **Visual Aids**: Use diagrams, screenshots, and other visual aids to enhance understanding.

README.md

Lines changed: 39 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,49 +5,66 @@
55
[![Netlify Status](https://api.netlify.com/api/v1/badges/6dbb93bc-ad39-4fda-849a-e542abdcfa7c/deploy-status)](https://app.netlify.com/sites/genocs-blog/deploys)
66

77
<p align="center">
8-
<img src="genocs-framework.png" alt="icon">
8+
<img src="./assets/images/gnx-framework.png" alt="Genocs Framework" width="400"/>
99
</p>
1010

1111
## How to contribute?
1212

1313
1. Fork this Repository.
14-
2. Navigate to your newly forked Repository -> Settings -> Secrets.
14+
2. Navigate to your newly forked `Repository -> Settings -> Secrets`.
1515
3. Here, Add a new Repository Secret with a name `GT_TOKEN`. As for the value, paste in your GitHub Token (https://github.com/settings/tokens)
1616
4. Now, clone this repository locally.
17-
5. Ensure that you have Node.js and Visual Code installed.
18-
6. At the root of the repository run `npm install`. This installs all the required packages.
19-
7. All the documentations are to be written in markdown format.
17+
5. Ensure that you have Node.js and VS Code installed.
18+
6. At the root of the repository run `npm install` (This installs all the required packages).
19+
7. All the documentations is written in markdown format.
2020
8. Refer https://github.com/Genocs/genocs-library-docs/blob/main/content/en/templates/general/getting-started/index.md to get an idea on how to write documentation and include images, code snippets and stuff.
2121
9. To run the application locally, run the command `npm run start` and navigate to localhost:1313
2222
10. Once ready, send a Pull Request.
2323

2424

25+
# How to build and run locally
26+
27+
1. Clone the repository
28+
2. Run the following commands to build and run the application locally
29+
```bash
30+
# install dependencies
31+
npm install
32+
# build the application release version
33+
npm run clean && npm run build
34+
# run the application locally
35+
npm run start
36+
```
37+
3. Navigate to localhost:1313 to view the documentation
38+
2539
# How to build and run on Docker
2640

2741
1. Clone the repository
2842
2. Run the following command to build the docker image
29-
```bash
30-
# build the application release version
31-
npm run clean && npm run build
43+
```bash
44+
# build the application release version
45+
npm run clean && npm run build
3246

33-
# build the docker image
34-
docker build -t genocs/genocs-library-docs .
47+
# build the docker image
48+
docker build -t genocs/genocs-library-docs .
3549

36-
# tag the image
37-
docker tag genocs/genocs-library-docs genocs/genocs-library-docs:1.2.1
38-
docker tag genocs/genocs-library-docs genocs/genocs-library-docs:latest
50+
# tag the image
51+
docker tag genocs/genocs-library-docs genocs/genocs-library-docs:1.3.0
52+
docker tag genocs/genocs-library-docs genocs/genocs-library-docs:latest
53+
54+
# build and tag in a single command
55+
docker build -t genocs/genocs-library-docs:latest -t genocs/genocs-library-docs:1.3.0 .
3956

40-
# login to docker hub
41-
docker login
57+
# login to docker hub
58+
docker login
4259

43-
# push the image to docker hub
44-
docker push genocs/genocs-library-docs:1.2.1
45-
docker push genocs/genocs-library-docs:latest
46-
```
60+
# push the image to docker hub
61+
docker push genocs/genocs-library-docs:1.3.0
62+
docker push genocs/genocs-library-docs:latest
63+
```
4764
3. Run the following command to run the docker image on localhost:1613
48-
```bash
49-
docker run -d -p 1613:80 genocs/genocs-library-docs
50-
```
65+
```bash
66+
docker run -d -p 1613:80 genocs/genocs-library-docs
67+
```
5168
4. Navigate to localhost:1613 to view the documentation
5269

5370

config/_default/params.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ copyRight = "Copyright (c) 2025 Genocs"
6969
# Alert
7070
alert = true
7171
alertDismissable = false
72-
alertText = ".NET 9.0 Genocs Library Released <a target=\"_blank\" class=\"alert-link\" href=\"https://www.youtube.com/watch?v=TgxDvU---Ak/\">Click here to get started!</a>"
72+
alertText = ".NET10.0 Genocs Library Released <a target=\"_blank\" class=\"alert-link\" href=\"https://www.youtube.com/watch?v=TgxDvU---Ak/\">Click here to get started!</a>"
7373

7474
# Edit Page
7575
repoHost = "GitHub"

content/en/blog/auth/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Authentication & Authorization"
3-
description: ".NET 9.0 - Boilerplate API Tutorial with Email Sign Up, Verification, Authentication & Forgot Password"
4-
lead: "Introducing about how to use authentication and authorization with NET9."
3+
description: ".NET10.0 - Boilerplate API Tutorial with Email Sign Up, Verification, Authentication & Forgot Password"
4+
lead: "Introducing about how to use authentication and authorization with NET10.0."
55
date: 2024-12-09T00:00:00+02:00
66
lastmod: 2024-12-09T00:00:00+02:00
77
draft: false
@@ -22,7 +22,7 @@ Authentication is implemented with JWT access tokens and refresh tokens. On succ
2222
HTTP Only cookies are used for refresh tokens to increase security because they are not accessible to client-side javascript which prevents XSS (cross site scripting) attacks. Refresh tokens only have access to generate new JWT tokens (via the */accounts/refresh-token route*), they cannot perform any other secure action which prevents them from being used in CSRF (cross site request forgery) attacks.
2323

2424
### API endpoints
25-
The example .NET9 API has the following endpoints/routes to demonstrate email sign up and verification, authentication and role based autorization, refreshing and revoking tokens, forgot password and reset password, and secure account management routes:
25+
The example .NET10.0 API has the following endpoints/routes to demonstrate email sign up and verification, authentication and role based autorization, refreshing and revoking tokens, forgot password and reset password, and secure account management routes:
2626

2727
- POST `/accounts/authenticate` - public route that accepts POST requests containing an email and password in the body. On success a JWT access token is returned with basic account details, and an HTTP Only cookie containing a refresh token.
2828
- POST `/accounts/refresh-token` - public route that accepts POST requests containing a cookie with a refresh token. On success a new JWT access token is returned with basic account details, and an HTTP Only cookie containing a new refresh token (see refresh token rotation just below for an explanation).
@@ -52,8 +52,8 @@ To try to keep things simple the boilerplate API uses a SQLite database, SQLite
5252
The boilerplate API project is available on GitHub at https://github.com/cornflourblue/dotnet-6-signup-verification-api.
5353

5454

55-
Tools required to run the .NET 6.0 Tutorial Example Locally
56-
To develop and run .NET 6.0 applications locally, download and install the following:
55+
Tools required to run the .NET10.0 Tutorial Example Locally
56+
To develop and run .NET10.0 applications locally, download and install the following:
5757

5858
.NET SDK - includes the .NET runtime and command line tools
5959
Visual Studio Code - code editor that runs on Windows, Mac and Linux

content/en/cli/index.md

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,7 @@ Genocs tool is based on [Microsoft-dotnet tools](https://learn.microsoft.com/en-
1818

1919
## Supported runtime
2020

21-
Genocs CLI can be used on both .NET6|8|9.
22-
23-
---
24-
25-
## Visual Studio Integration
26-
27-
The Genocs CLI is integrated with Visual Studio. You can use the Genocs CLI to create, build, and run applications directly from Visual Studio. The Genocs CLI provides a unified experience across different platforms, allowing you to create cross-platform applications with ease. You can use the Genocs CLI to automate tasks such as project management, dependency resolution, and deployment. The Genocs CLI is an essential tool for modern developers, offering productivity, flexibility, and scalability in application development.
28-
29-
{{< img src="vs_integration.png" >}}
21+
Genocs CLI can be used on both .NET10.x, .NET9.x, .NET8.x.
3022

3123
---
3224

@@ -36,13 +28,13 @@ To install the tool the only thing you must do is to take it from NuGet, install
3628

3729
{{< img src="initialize.png" >}}
3830

39-
``` bash
31+
```bash
4032
dotnet tool install -g genocs.cli
4133
```
4234

4335
### Useful commands
4436

45-
``` bash
37+
```bash
4638
# Get the list of tools
4739
dotnet tool list
4840

@@ -85,7 +77,7 @@ The picture shows the console log upon the template is installed.
8577

8678
To uninstall the templates, you can use the following command:
8779

88-
``` bash
80+
```bash
8981
# Get the templates list
9082
dotnet new uninstall
9183

@@ -97,11 +89,11 @@ dotnet new uninstall Genocs.MicroserviceTemplate
9789
dotnet new uninstall Genocs.Microservice.Template
9890
```
9991

100-
### blazor
92+
### Blazor
10193

10294
To create a blazor portal use one of these commands
10395

104-
``` bash
96+
```bash
10597
# To build a blazor portal
10698
genocs blazor-wasm new <Company.Project.Service>
10799

@@ -111,7 +103,7 @@ genocs blazor-clean new <Company.Project.Service>
111103

112104
### WebAPI
113105

114-
``` bash
106+
```bash
115107
# To build a web api architecture webapi
116108
genocs libra-webapi new <Company.Project.Service>
117109

@@ -132,7 +124,7 @@ You are free to fork or to clone it. Then you can update it at your own pace.
132124

133125
### Useful commands to work on your own
134126

135-
``` bash
127+
```bash
136128
# Build the project
137129
dotnet build ./src/genocs.cli.csproj
138130

@@ -155,7 +147,7 @@ dotnet tool install --global --add-source ./src/nupkg genocs.cli
155147
In the following section, you will find the commands to create a new service from scratch.
156148
For sake of simplicity, we will change the name of the service from `<Company.Project.Service>` to a demo name.
157149

158-
``` bash
150+
```bash
159151
# To build a microservice web Api with multitenant support
160152
genocs micro-webapi n Genocs.TestWebApi
161153

@@ -176,15 +168,24 @@ dotnet run --project ./Genocs.TestWebApi/src/WebApi/WebApi.csproj
176168
dotnet run --project ./Genocs.TestWebBlazorPortal/src/Host/Host.csproj
177169
```
178170

179-
``` mermaid
171+
```mermaid
180172
architecture-beta
181-
group api(logos:aws-lambda)[Example]
173+
group api(cloud)[Microservice]
182174
183-
service webapp(logos:aws-cognito)[WebApp] in api
184-
service webapi(logos:aws-lambda)[WebApi] in api
185-
service db(logos:aws-documentdb)[Database] in api
175+
service fe(server)[FrontEnd] in api
176+
service be(server)[BackEnd] in api
177+
service db(database)[Database] in api
178+
service disk1(disk)[Storage] in api
186179
187-
db:T -- B:webapi
188-
webapi:L -- R:webapp
180+
fe:B --> T:be
181+
be:B --> T:db
182+
be:L --> R:disk1
183+
```
184+
185+
---
186+
187+
## Visual Studio Integration
188+
189+
The Genocs CLI is integrated with Visual Studio. You can use the Genocs CLI to create, build, and run applications directly from Visual Studio. The Genocs CLI provides a unified experience across different platforms, allowing you to create cross-platform applications with ease. You can use the Genocs CLI to automate tasks such as project management, dependency resolution, and deployment. The Genocs CLI is an essential tool for modern developers, offering productivity, flexibility, and scalability in application development.
189190

190-
```
191+
{{< img src="vs_integration.png" >}}

0 commit comments

Comments
 (0)