Skip to content

Commit e118c4b

Browse files
committed
docs: Move documentation into its own package
1 parent 519cac5 commit e118c4b

File tree

269 files changed

+37444
-119
lines changed

Some content is hidden

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

269 files changed

+37444
-119
lines changed

.github/workflows/deploy-docs-next.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ jobs:
4747
uses: actions/configure-pages@v4
4848
- name: Install dependencies
4949
run: npm ci
50+
- name: Install documentation dependencies
51+
run: cd packages/documentation && npm ci
5052
- name: Fetch gh-pages branch
5153
run: git fetch origin gh-pages --depth=1
5254
- name: Set /site ownership to current user
@@ -60,7 +62,7 @@ jobs:
6062
- name: Build jsdoc
6163
run: npm run jsdoc-generate
6264
- name: Build vitepress build
63-
run: npm run docs-generate
65+
run: npm run docs:build
6466
- name: Build Schema
6567
run: |
6668
npm run schema-generate
@@ -75,7 +77,7 @@ jobs:
7577
rm -rf ./gh-pages/schema
7678
cp -R ./site/schema ./gh-pages/
7779
rm -rf ./gh-pages/next/
78-
cp -R ./site ./gh-pages/next/
80+
cp -R ./packages/documentation/dist ./gh-pages/next/
7981
cp ./scripts/resources/custom404.html ./gh-pages/404.html
8082
- name: Publish Docs
8183
run: |

.github/workflows/deploy-docs-stable.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ jobs:
4747
uses: actions/configure-pages@v4
4848
- name: Install dependencies
4949
run: npm ci
50+
- name: Install documentation dependencies
51+
run: cd packages/documentation && npm ci
5052
- name: Fetch gh-pages branch
5153
run: git fetch origin gh-pages --depth=1
5254
- name: Set /site ownership to current user
@@ -60,7 +62,7 @@ jobs:
6062
- name: Build jsdoc
6163
run: npm run jsdoc-generate
6264
- name: Build vitepress build
63-
run: npm run docs-generate
65+
run: npm run docs:build
6466
- name: Build Schema
6567
run: |
6668
npm run schema-generate
@@ -75,7 +77,7 @@ jobs:
7577
rm -rf ./gh-pages/schema
7678
cp -R ./site/schema ./gh-pages/
7779
rm -rf ./gh-pages/stable/
78-
cp -R ./site ./gh-pages/stable/
80+
cp -R ./packages/documentation/dist ./gh-pages/stable/
7981
cp ./scripts/resources/custom404.html ./gh-pages/404.html
8082
- name: Publish Docs
8183
run: |

docs/README.md

Lines changed: 0 additions & 50 deletions
This file was deleted.

package.json

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@
2929
"jsdoc-generate": "node ./scripts/isWorkspace.js && npm run jsdoc-generate-workspace || npm run jsdoc-generate-local",
3030
"jsdoc-generate-local": "jsdoc -c ./jsdoc.json -t $(node -p 'path.dirname(require.resolve(\"docdash\"))') ./ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
3131
"jsdoc-generate-workspace": "jsdoc -c ./jsdoc-workspace.json -t $(node -p 'path.dirname(require.resolve(\"docdash\"))') ../ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
32-
"start": "vitepress --open",
33-
"serve-docs": "vitepress build && vitepress preview --port 8080",
34-
"docs-generate": "vitepress build",
32+
"docs:dev": "npm --prefix packages/documentation run dev",
33+
"docs:build": "npm --prefix packages/documentation run build",
34+
"docs:preview": "npm --prefix packages/documentation run preview",
3535
"schema-generate": "node ./scripts/buildSchema.js ui5",
3636
"schema-workspace-generate": "node ./scripts/buildSchema.js ui5-workspace",
3737
"generate-cli-doc": "node ./scripts/generateCliDoc.js",
@@ -67,18 +67,6 @@
6767
"open-cli": "^8.0.0",
6868
"traverse": "^0.6.11",
6969
"@odata2ts/http-client-fetch": "^0.8.0",
70-
"@odata2ts/odata2ts": "^0.37.0",
71-
"@types/markdown-it-plantuml": "^1.4.5",
72-
"@types/node": "^22.5.1",
73-
"@ui5/webcomponents": "^2.1.2",
74-
"autoprefixer": "^10.4.20",
75-
"cssnano": "^7.0.5",
76-
"markdown-it-implicit-figures": "^0.12.0",
77-
"markdown-it-link-attributes": "^4.0.1",
78-
"markdown-it-plantuml": "^1.4.1",
79-
"postcss": "^8.4.41",
80-
"tailwindcss": "^3.4.10",
81-
"vitepress": "^1.3.4",
82-
"vue": "^3.4.38"
70+
"@odata2ts/odata2ts": "^0.37.0"
8371
}
8472
}

.vitepress/cache/deps/_metadata.json renamed to packages/documentation/.vitepress/cache/deps/_metadata.json

File renamed without changes.

.vitepress/cache/deps/chunk-QKXXKPGR.js renamed to packages/documentation/.vitepress/cache/deps/chunk-QKXXKPGR.js

File renamed without changes.

.vitepress/cache/deps/chunk-QKXXKPGR.js.map renamed to packages/documentation/.vitepress/cache/deps/chunk-QKXXKPGR.js.map

File renamed without changes.

.vitepress/cache/deps/chunk-XV6CE6JT.js renamed to packages/documentation/.vitepress/cache/deps/chunk-XV6CE6JT.js

File renamed without changes.

.vitepress/cache/deps/chunk-XV6CE6JT.js.map renamed to packages/documentation/.vitepress/cache/deps/chunk-XV6CE6JT.js.map

File renamed without changes.

.vitepress/cache/deps/package.json renamed to packages/documentation/.vitepress/cache/deps/package.json

File renamed without changes.

0 commit comments

Comments
 (0)