Skip to content

Commit b78248e

Browse files
committed
chore: update-doc-commands
1 parent 07d1c13 commit b78248e

File tree

7 files changed

+13
-4
lines changed

7 files changed

+13
-4
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ jobs:
6666
retention-days: 30
6767

6868
- name: build docs
69-
run: pnpm typedoc
69+
run: pnpm generate-docs
7070

7171
- name: preview-docs
7272
uses: rajyan/preview-pages@v1

.github/workflows/publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ jobs:
9191
token: ${{ secrets.CODECOV_TOKEN }}
9292

9393
- name: Build docs
94-
run: pnpm typedoc
94+
run: pnpm generate-docs
9595

9696
- name: Publish api docs
9797
if: steps.changesets.outputs.published == 'true'

eslint.config.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ export default [
2323
{
2424
ignores: [
2525
'**/dist',
26+
'**/docs',
2627
'**/vite.config.*.timestamp*',
2728
'**/vitest.config.*.timestamp*',
2829
'**/out-tsc',

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"commit": "git cz",
2323
"commitlint": "commitlint --edit",
2424
"create-package": "nx g @nx/js:library",
25-
"docs": "nx affected --target=typedoc",
25+
"generate-docs": "typedoc",
2626
"format": "pnpm nx format:write",
2727
"lint": "nx affected --target=lint",
2828
"local-release": "pnpm ts-node tools/release/release.ts",
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"name": "@forgerock/iframe-manager",
3+
"entryPoints": ["src/index.ts"]
4+
}
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"name": "@forgerock/storage",
3+
"entryPoints": ["src/index.ts"]
4+
}

typedoc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"hideGenerator": true,
1111
"searchInComments": true,
1212
"navigationLinks": {
13-
"GitHub": "https://github.com/yourusername/yourrepo"
13+
"GitHub": "https://github.com/ForgeRock/ping-javascript-sdk"
1414
},
1515
"packageOptions": {
1616
"tsconfig": "tsconfig.lib.json",

0 commit comments

Comments
 (0)