Skip to content

Commit 9ebfab1

Browse files
authored
refactor: Remove obsolete docfx tools-dep (#1306)
* refactor: Remove obsolete docfx tools-dep * refactor: Correct docs and make docfx run inside IDE * refactor: readded launchsettings.json
1 parent 5976b86 commit 9ebfab1

4 files changed

Lines changed: 19 additions & 13 deletions

File tree

.config/dotnet-tools.json

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,6 @@
77
"commands": [
88
"dotnet-serve"
99
]
10-
},
11-
"docfx": {
12-
"version": "2.74.0",
13-
"commands": [
14-
"docfx"
15-
]
1610
}
1711
}
1812
}

.github/workflows/docs-deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ jobs:
8686
- name: 🛠️ Building bUnit
8787
run: dotnet build /p:PublicRelease=true
8888

89-
- name: 🛠️ Verfiy docs samples
89+
- name: 🛠️ Verify docs samples
9090
run: dotnet test docs/samples/samples.sln
9191

9292
- name: 📄 Building docs

docs/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,17 @@ These sample components, source files, and tests source files are included in th
2121
The following chapter describes how you can run and view the documentation locally
2222

2323
### Requirements
24-
You will need the following tools installed:
24+
You will need the following tool installed:
2525
* The [`dotnet serve` tool](https://github.com/natemcmaster/dotnet-serve)
26-
* [DocFx](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#2-use-docfx-as-a-command-line-tool) to generate the html files
26+
* [DocFx](https://dotnet.github.io/docfx/tutorial/docfx_getting_started).
2727

2828
### View the documentation
2929

30-
1. From `docs/site` run `dotnet build`. If you get warnings from running `dotnet build`, try running it again.
31-
2. From `docs/` run `docfx`. This will generate all the html site based on the markdown files.
32-
3. From `docs/` run `serve-docs.cmd`. This will start up a local web server, hosting the generated documentation site.
33-
4. After changing samples from `docs/samples`, run `dotnet test`. This will compile the sample components and run the sample tests.
30+
1. Build the `bunit.sln` solution in the root folder.
31+
2. From `docs/site` run `dotnet build`. If you get warnings from running `dotnet build`, try running it again.
32+
3. Inside `docs/site` run `dotnet run` to start the generation.
33+
4. From `docs/` run `serve-docs.cmd`. This will start up a local web server, hosting the generated documentation site.
34+
5. After changing samples from `docs/samples`, run `dotnet test`. This will compile the sample components and run the sample tests.
3435

3536
## Documentation Writing Rules
3637

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"profiles": {
3+
"Site": {
4+
"commandName": "Project",
5+
"environmentVariables": {
6+
"DOTNET_ENVIRONMENT": "Development"
7+
},
8+
"workingDirectory": "$(MSBuildProjectDirectory)"
9+
}
10+
}
11+
}

0 commit comments

Comments
 (0)