Skip to content

Commit 32da84f

Browse files
authored
Revise index.md for improved documentation clarity
Updated documentation structure and content, replacing 'Website' with 'Documentation' and removing sections on usage, build, testing, and code coverage.
1 parent e182bbf commit 32da84f

File tree

1 file changed

+1
-135
lines changed

1 file changed

+1
-135
lines changed

index.md

Lines changed: 1 addition & 135 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ It does not depend on other libraries.
2020

2121
You can install the CryptoNet NuGet package via [NuGet](https://www.nuget.org/packages/CryptoNet).
2222

23-
## Website
23+
## Documentation
2424

2525
https://itbackyard.github.io/CryptoNet
2626

@@ -44,137 +44,3 @@ CryptoNet Extensions v3:
4444
## Issues
4545

4646
Please report issues [here](https://github.com/itbackyard/CryptoNet/issues).
47-
48-
## How to use
49-
Ref to docs.
50-
51-
## Build and Testing
52-
You have different options to build and run the unit tests from:
53-
1. Visual Studio 2019/2022.
54-
2. Visual Studio Code.
55-
3. dotnet command line.
56-
4. dotnet commands are preserved in a PowerShell script ```build.ps1```.
57-
5. Docker, run the following command from the solution folder:
58-
59-
```
60-
docker build . --file .\Dockerfile --tag cryptonet-service:latest
61-
```
62-
63-
or run preserved PowerShell:
64-
65-
```powershell
66-
./run_docker_build.ps1
67-
```
68-
69-
## How to release a new version?
70-
71-
Preview
72-
```
73-
.\run_release.ps1 -VersionNumber 3.0.0 -IsPreview $true
74-
```
75-
76-
Release
77-
```
78-
.\run_release.ps1 -VersionNumber 3.0.0 -IsPreview $false
79-
```
80-
81-
## Documentation Creation
82-
83-
There are static and dynamically generated documentation. Both are published automatically in the pipeline called `5-static.yml`.
84-
85-
To work with the documentation locally, the following might be relevant:
86-
87-
- **Static base documentation** is located in the `docs` folder.
88-
- **Dynamically generated documentation** is created from code using a tool called **DocFX**.
89-
90-
### Running Documentation Creation Locally
91-
92-
To generate the documentation locally on your computer, run:
93-
94-
```powershell
95-
.\run_docs.ps1
96-
```
97-
98-
### Setup
99-
100-
1. Install the DocFX tool (only needs to be done once):
101-
102-
```
103-
dotnet tool install -g docfx
104-
```
105-
106-
2. The following step is already configured in this repository. However, if you need to start over, run the following to initialize and configure DocFX:
107-
108-
```
109-
docfx init -y
110-
```
111-
112-
## Update `index.md` with `README.md`
113-
114-
To update `index.md` with the latest content from `README.md`, run the following command:
115-
116-
```powershell
117-
./run_update_index.ps1
118-
```
119-
This script will:
120-
121-
1. Add the following header to the top of `index.md`:
122-
123-
```yaml
124-
---
125-
_layout: landing
126-
---
127-
```
128-
129-
2. Append the content of `README.md` to `index.md`.
130-
131-
This ensures that index.md is always up to date with the latest changes in `README.md`.
132-
133-
## Code Coverage
134-
135-
Code coverage ensures that your tests adequately cover your codebase, improving overall quality, reliability, and maintainability. Follow these steps to set up and generate code coverage reports.
136-
137-
### Running Code Coverage Locally
138-
139-
To generate code coverage reports locally on your computer, run the following command in Windows:
140-
141-
```powershell
142-
.\run_codecoverage.ps1
143-
```
144-
145-
### Setup
146-
147-
If the required tools and packages are not set up locally, follow the steps below to configure them:
148-
149-
1. Navigate to your test project directory (e.g., `CryptoNet.UnitTests`):
150-
151-
```bash
152-
cd .\CryptoNet.UnitTests\
153-
```
154-
155-
2. Add the necessary coverage packages to your test project:
156-
157-
```bash
158-
dotnet add package coverlet.collector
159-
dotnet add package coverlet.msbuild
160-
```
161-
162-
3. Install the report generator tool (only needs to be done once):
163-
164-
```bash
165-
dotnet tool install --global dotnet-reportgenerator-globaltool
166-
```
167-
168-
Once set up, you can use these tools to analyze and generate detailed code coverage reports to ensure thorough testing of your application.
169-
170-
## Contributing
171-
172-
You are more than welcome to contribute in one of the following ways:
173-
174-
1. Basic: Give input, and suggestions for improvement by creating an issue and labeling it https://github.com/itbackyard/CryptoNet/issues
175-
2. Advance: if you have good knowledge of C# and Cryptography just grab one of the issues, or features, or create a new one and refactor and add a pull request.
176-
3. Documentation: Add, update, or improve documentation, by making a pull request.
177-
178-
### How to contribute:
179-
180-
[Here](https://www.dataschool.io/how-to-contribute-on-github/) is a link to learn how to contribute if you are not aware of how to do it.

0 commit comments

Comments
 (0)