Skip to content

docs: Migrate API Docs to Vitepress#1240

Merged
werwolf2303 merged 2 commits intomainfrom
jsdoc-to-markdow
Feb 13, 2026
Merged

docs: Migrate API Docs to Vitepress#1240
werwolf2303 merged 2 commits intomainfrom
jsdoc-to-markdow

Conversation

@d3xter666
Copy link
Copy Markdown
Member

JIRA: CPOUI5FOUNDATION-904

@d3xter666 d3xter666 marked this pull request as draft December 11, 2025 07:33
@cla-assistant
Copy link
Copy Markdown

cla-assistant bot commented Dec 11, 2025

CLA assistant check
All committers have signed the CLA.

@coveralls
Copy link
Copy Markdown

coveralls commented Dec 11, 2025

Coverage Status

coverage: 94.305% (-0.03%) from 94.337%
when pulling 9900e70 on jsdoc-to-markdow
into 8912d46 on main.

Comment thread internal/documentation/jsdoc-to-markdown.js Fixed
Comment thread internal/documentation/jsdoc-to-markdown-v1.js Fixed
Comment thread internal/documentation/jsdoc/docdash/publish.js Fixed
Comment thread internal/documentation/jsdoc/docdash/publish.js Fixed
Comment thread internal/documentation/jsdoc/jsdoc.json Outdated
Comment thread packages/server/lib/middleware/testRunner/TestRunner.js Outdated
Comment thread CONTRIBUTING.md Outdated
Copy link
Copy Markdown
Member Author

@d3xter666 d3xter666 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And one general comment:

We shall not modify the content within packages/ folder, nor delete anything from there. That will impact the UI5 CLI functionality, tests and docs

Comment thread internal/documentation/jsdoc-to-markdown-v1.js Outdated
Comment thread internal/documentation/jsdoc-to-markdown-v1.js Outdated
Comment thread internal/documentation/jsdoc-to-markdown-v1.js Outdated
Comment thread internal/documentation/jsdoc/docdash/CHANGELOG.md Outdated
Comment thread packages/builder/lib/lbt/resources/ModuleInfo.js Outdated
@werwolf2303 werwolf2303 force-pushed the jsdoc-to-markdow branch 8 times, most recently from 075a37e to 426458e Compare January 20, 2026 10:26
@matz3
Copy link
Copy Markdown
Member

matz3 commented Jan 20, 2026

There are still some dead links. You can find them by searching for .md" within ./internal/documentation/dist/api. Note that some of those links are correct (e.g. links to a RFC document on GitHub).

Please continue to create new commits, as that makes reviewing changes easier. We can squash all commits again after all open points have been addressed.

Comment thread internal/documentation/jsdoc/docdash/publish.js Fixed
@werwolf2303 werwolf2303 force-pushed the jsdoc-to-markdow branch 3 times, most recently from 64b5efc to c29381a Compare January 22, 2026 08:22
Comment thread internal/documentation/.vitepress/config.ts Outdated
Comment thread internal/documentation/.vitepress/config.ts Outdated
@werwolf2303 werwolf2303 marked this pull request as ready for review February 4, 2026 11:31
Comment thread REUSE.toml Outdated
Comment thread internal/documentation/jsdoc/docdash/LICENSE.md
Comment thread internal/documentation/jsdoc/docdash/package.json
@matz3 matz3 changed the title feat: Integrate JSDoc output into vitepress docs: Migrate API Docs to Vitepress Feb 12, 2026
@werwolf2303 werwolf2303 merged commit c0ac7dd into main Feb 13, 2026
30 checks passed
@werwolf2303 werwolf2303 deleted the jsdoc-to-markdow branch February 13, 2026 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants