Skip to content

Commit 0bd5270

Browse files
committed
unified 2 separate typedoc sites into one on the main github pages page
1 parent 63841a6 commit 0bd5270

5 files changed

Lines changed: 12 additions & 3 deletions

File tree

.github/workflows/docs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ concurrency:
1919

2020
jobs:
2121
deploy:
22+
env:
23+
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
2224
environment:
2325
name: github-pages
2426
url: ${{ steps.deployment.outputs.page_url }}

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"scripts": {
99
"build": "npm run build --workspaces --if-present",
1010
"test": "npm run test --workspaces --if-present",
11-
"docs": "npm run docs --workspaces --if-present"
11+
"docs": "typedoc --options typedoc.json"
1212
},
1313
"devDependencies": {
1414
"typedoc": "0.28.17"

packages/raft-core/typedoc.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"entryPoints": ["src/index.ts"],
3-
"out": "../../docs/raft-core",
43
"tsconfig": "./tsconfig.json",
54
"excludePrivate": true,
65
"excludeInternal": true

packages/raft-grpc/typedoc.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"entryPoints": ["src/index.ts"],
3-
"out": "../../docs/raft-grpc",
43
"tsconfig": "./tsconfig.json",
54
"excludePrivate": true,
65
"excludeInternal": true

typedoc.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"name": "Raft Consensus Algorithm",
3+
"entryPointStrategy": "packages",
4+
"entryPoints": [
5+
"packages/raft-core",
6+
"packages/raft-grpc"
7+
],
8+
"out": "docs"
9+
}

0 commit comments

Comments
 (0)