feat: Enable vitepress build #1133

d3xter666 · 2025-10-02T11:44:48Z

This change continues the efforts from #1132 and enhances it by enabling vitepress build of the documentation.

JIRA: CPOUI5FOUNDATION-899

.gitignore

packages/documentation/docs/pages/Guidelines.md

packages/documentation/docs/index.md

maxreichmann · 2025-10-20T15:22:02Z

/pages/CLI.html returns a 404.
It is referenced multiple times such as in the sidebar or in /pages/GettingStarted.html as "Next page"

d3xter666 · 2025-10-21T07:42:23Z

/pages/CLI.html returns a 404. It is referenced multiple times such as in the sidebar or in /pages/GettingStarted.html as "Next page"

The CLI page must be generated via the npm run generate-cli-doc script in the root of the monorepo

packages/documentation/docs/pages/GettingStarted.md

maxreichmann · 2025-10-21T15:06:51Z

Remark 1:
Wouldn't it make sense to move all the migration guide files from packages/documentation/docs/updates to the general pages directory packages/documentation/docs/pages?
We would then have all files in a combined directory and this would fix some 404 linkings e.g. of the button "Migrate to v4" on Home.html.

Remark 2:
These migration guide files contain wrongly formatted info/warning/success elements which have to be replaced.
e.g.:

For !!! tip, we can use ::: tip [...] ::: and remove the indendation
the same works for !!! warning
for !!! success, we have to find a different alternative

Since those files haven't been touched in this PR yet, I couldn't create a GH code suggestion.

packages/documentation/docs/pages/Configuration.md

d3xter666 · 2025-10-22T07:28:25Z

We would then have all files in a combined directory and this would fix some 404 linkings e.g. of the button "Migrate to v4" on Home.html.

My intention was to do the cleanup in the next step, but now I have fixed the formatting and links.
Thanks!

…op level

This PR aims to cleanup redundant files & configurations from the legacy MkDocs build JIRA: CPOUI5FOUNDATION-899

Co-authored-by: Max Reichmann <[email protected]>

packages/documentation/docs/updates/migrate-v4.md

Co-authored-by: Max Reichmann <[email protected]>

maxreichmann · 2025-10-22T08:49:19Z

I really don't wanna be picky, but the last change regarding removing the quotes would need to be applied for every ::: occurrence where it is necessary 😅

packages/documentation/docs/updates/migrate-v3.md

matz3 · 2025-10-24T13:26:53Z

packages/documentation/.vitepress/config.ts

+
+export default defineConfig({
+
+  base: "/ui5-cli/stable/", // use this for github pages deployment or remove for CF


Is this the right url? ui5-cli?
Currently it does not appear anywhere. Our docs URLs look like this: https://ui5.github.io/cli/

matz3 · 2025-10-24T13:29:42Z

packages/documentation/.vitepress/theme/loaders/trippin.data.js

+export default {
+    async load() {
+        // fetch remote data
+        const service = 'https://services.odata.org/Trippin_Staging/(S(iw1anra4xygjyssbeef0yeyy))'


Where do we need this?

matz3 · 2025-10-24T13:30:46Z

packages/documentation/.vitepress/theme/model/trippin/TrippinService.d.ts

+    private _qResetDataSource?;
+    people(): PersonCollectionService<ClientType>;
+    people(id: PersonId): PersonService<ClientType>;
+    airlines(): AirlineCollectionService<ClientType>;


I do not think that this whole folder is needed for our documentation.

matz3 · 2025-10-24T13:34:41Z

packages/documentation/docs/pages/Benchmarking.md

    1. Switch to the branch that contains your change
        ```sh
-        (cd ../ui5-builder && git checkout my-change)
+        (cd ../pages/builder && git checkout my-change)


This looks like an unexpected change (also few lines below).

matz3 · 2025-10-24T13:35:27Z

packages/documentation/docs/pages/Builder.md


-[**API Reference**](https://ui5.github.io/cli/v4/api/index.html){: .md-button .sap-icon-initiative }
+<div style="margin: 1rem 0;">
+  <VPButton class="no-decoration" text="📚 API Reference" href="https://ui5.github.io/cli/v4/api/index.html"/>


Why is there a link specifically for v4? Isn't this the v5 / next version here?

matz3 · 2025-10-24T14:06:07Z

packages/documentation/.vitepress/config.ts

+
+  description: "An open and modular toolchain to develop state-of-the-art applications based on the UI5 framework.",
+  lastUpdated: false, // disable git author info
+  cleanUrls: false,


Is this the setting that would remove the additional .html from the URLs? In our current documentation we don't have a .html extension for the pages, but in the version here I get URLs like http://localhost:8080/ui5-cli/v5/pages/Configuration.html, which might break links and/or SEO.

matz3 · 2025-10-24T14:07:06Z

packages/documentation/.vitepress/config.ts

+  description: "An open and modular toolchain to develop state-of-the-art applications based on the UI5 framework.",
+  lastUpdated: false, // disable git author info
+  cleanUrls: false,
+  ignoreDeadLinks: true,


Is there a reason for this setting?

matz3 · 2025-10-24T14:11:06Z

packages/documentation/.vitepress/config.ts

+  head: [
+    [
+      "link",
+      { rel: "icon", type: "image/svg+xml", href: "/icons/ui5/O.svg" }


where is this file?

matz3 · 2025-10-24T14:11:37Z

packages/documentation/.vitepress/config.ts

+
+
+    logo: {
+      light: "/images/Logo_B_RGB.png",


I'm not sure whether an absolute URL will work, as the site is hosted at https://ui5.github.io/cli/

matz3 · 2025-10-24T14:12:32Z

packages/documentation/.vitepress/config.ts

+      md.use(MarkdownItPlantuml, {
+        //imageFormat: 'png'
+      });
+      // https://github.com/gmunguia/markdown-it-plantuml/issues/35
+      md.use(MarkdownItPlantuml, {
+        openMarker: "```plantuml",
+        closeMarker: "```",
+        diagramName: "uml",
+        imageFormat: "svg",
+      });
+      // Textik https://textik.com/
+      md.use(MarkdownItPlantuml, {
+        openMarker: "```ditaa",
+        closeMarker: "```",
+        diagramName: "ditaa",
+        imageFormat: "png",
+      });


do we need this?

maxreichmann · 2025-10-24T14:27:42Z

packages/documentation/docs/updates/migrate-v3.md


-!!! warning "Superseded"
-	**UI5 CLI 3.0 has been superseded by version 4.0. See [Migrate to v4](./migrate-v4.md).**
+::: warning "Superseded"


Suggested change

::: warning "Superseded"

::: warning Superseded

maxreichmann · 2025-10-24T14:28:02Z

packages/documentation/docs/updates/migrate-v4.md


-!!! success "No changes for Specification Versions 2.x and 3.x"
-    Projects defining **Specification Version 2.x or 3.x** are expected to be **fully compatible with UI5 CLI v4**
+::: info "No changes for Specification Versions 2.x and 3.x"


Suggested change

::: info "No changes for Specification Versions 2.x and 3.x"

::: info No changes for Specification Versions 2.x and 3.x

d3xter666 force-pushed the feat-create-docsumentation-package branch from 037ceae to 31934ec Compare October 10, 2025 11:37

d3xter666 force-pushed the feat-enable-vitepress branch from 8961b0d to 7a2ce4f Compare October 10, 2025 11:39

d3xter666 requested a review from a team October 10, 2025 11:41

RandomByte requested changes Oct 13, 2025

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

.gitignore Outdated Show resolved Hide resolved

packages/documentation/docs/pages/Guidelines.md Show resolved Hide resolved

d3xter666 force-pushed the feat-create-docsumentation-package branch from 64066ac to f3a5128 Compare October 14, 2025 06:51

d3xter666 force-pushed the feat-enable-vitepress branch 2 times, most recently from 6afdfe1 to 36c75f1 Compare October 14, 2025 11:02

d3xter666 force-pushed the feat-create-docsumentation-package branch from 0107968 to af5446d Compare October 14, 2025 12:27

Base automatically changed from feat-create-docsumentation-package to main October 14, 2025 12:34

d3xter666 force-pushed the feat-enable-vitepress branch from 7d5eba8 to 8beda5d Compare October 14, 2025 12:38

d3xter666 requested a review from RandomByte October 14, 2025 13:08

flovogt mentioned this pull request Oct 15, 2025

[WIP][FEATURE] Migrate UI5 Tooling documentation to VitePress #1009

Closed

d3xter666 requested a review from a team October 16, 2025 06:56

d3xter666 force-pushed the feat-enable-vitepress branch from c1e36b7 to a934f2a Compare October 20, 2025 09:48

maxreichmann reviewed Oct 20, 2025

View reviewed changes

packages/documentation/docs/index.md Show resolved Hide resolved

maxreichmann reviewed Oct 20, 2025

View reviewed changes

packages/documentation/docs/index.md Outdated Show resolved Hide resolved

maxreichmann reviewed Oct 20, 2025

View reviewed changes

packages/documentation/docs/index.md Outdated Show resolved Hide resolved

d3xter666 force-pushed the feat-enable-vitepress branch from a934f2a to c1e36b7 Compare October 21, 2025 06:25

d3xter666 requested a review from maxreichmann October 21, 2025 07:42

d3xter666 force-pushed the feat-enable-vitepress branch from d0c7ac3 to 5311640 Compare October 21, 2025 08:37

maxreichmann reviewed Oct 21, 2025

View reviewed changes

packages/documentation/docs/pages/GettingStarted.md Outdated Show resolved Hide resolved

maxreichmann reviewed Oct 21, 2025

View reviewed changes

packages/documentation/docs/pages/GettingStarted.md Outdated Show resolved Hide resolved

maxreichmann reviewed Oct 21, 2025

View reviewed changes

packages/documentation/docs/pages/Configuration.md Outdated Show resolved Hide resolved

d3xter666 added 3 commits October 22, 2025 10:28

refactor: Create separate package for documentation

7d1aefc

refactor: Move /docs to the newly create package

4df5346

refactor: Guidelines are for the whole project and should be at the t…

c19c6dc

…op level

d3xter666 and others added 16 commits October 22, 2025 10:28

fix: CLI.md parsing for vitepress

a153524

feat: Cleanup documentation (#1135)

4d9c459

This PR aims to cleanup redundant files & configurations from the legacy MkDocs build JIRA: CPOUI5FOUNDATION-899

refactor: Remove unnecessary files from .git

ce046e3

refactor: Enable .git ignore rules after cleanup

0a4d17f

refactor: Correct .gitignore rules

de09f45

refactor: Cleanup redundant configurations

99f6427

refactor: Use light & dark logos

4f6e88d

fix: Restore Guidelines.md

8e3378e

refactor: Use vitepress buttons

89a7b8c

refactor: Cleanup

6d14ef8

fix: Remove redundant formatting

5099c11

refactor: Align indexes

338294d

refactor: Align indexes

1811978

fix: Bad links

de7a2b8

fix: Markdowns formatting

1a412ce

fix: Internal links

e0aa321

d3xter666 force-pushed the feat-enable-vitepress branch from de2cb77 to e0aa321 Compare October 22, 2025 07:28

fix: Broken link

e87b4c1

d3xter666 requested a review from maxreichmann October 22, 2025 08:24

docs: Update packages/documentation/docs/pages/GettingStarted.md

2f7d030

Co-authored-by: Max Reichmann <[email protected]>

maxreichmann reviewed Oct 22, 2025

View reviewed changes

packages/documentation/docs/updates/migrate-v4.md Outdated Show resolved Hide resolved

docs: Update packages/documentation/docs/updates/migrate-v4.md

4c27493

Co-authored-by: Max Reichmann <[email protected]>

d3xter666 requested a review from maxreichmann October 22, 2025 08:42

maxreichmann reviewed Oct 22, 2025

View reviewed changes

packages/documentation/docs/updates/migrate-v3.md Outdated Show resolved Hide resolved

fix: Bad formatting

78b592d

d3xter666 requested review from a team and maxreichmann October 22, 2025 10:33

matz3 reviewed Oct 24, 2025

View reviewed changes

maxreichmann reviewed Oct 24, 2025

View reviewed changes


		export default defineConfig({

		base: "/ui5-cli/stable/", // use this for github pages deployment or remove for CF

	::: info "No changes for Specification Versions 2.x and 3.x"
	::: info No changes for Specification Versions 2.x and 3.x

feat: Enable vitepress build #1133

Are you sure you want to change the base?

feat: Enable vitepress build #1133

Uh oh!

Conversation

d3xter666 commented Oct 2, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

maxreichmann commented Oct 20, 2025

Uh oh!

d3xter666 commented Oct 21, 2025

Uh oh!

Uh oh!

Uh oh!

maxreichmann commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

d3xter666 commented Oct 22, 2025

Uh oh!

Uh oh!

maxreichmann commented Oct 22, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

maxreichmann commented Oct 21, 2025 •

edited

Loading