Skip to content

docs: Several refactorings - #1473

Open
maxreichmann wants to merge 1 commit into
mainfrom
docs-refactor
Open

docs: Several refactorings#1473
maxreichmann wants to merge 1 commit into
mainfrom
docs-refactor

Conversation

@maxreichmann

@maxreichmann maxreichmann commented Jul 22, 2026

Copy link
Copy Markdown
Member

This PR includes the outsourced "Side tasks done" from original PR #1453.
Following changes have been made:

  • docs: Replace hardcoded URLs (ui5.github.io/..) with dynamic links
  • docs: Replace dead "API Reference" links
    • Guide the reader to use the new sidebar menu
    • Add "📚" emoji to "API" in sidebar to mimic depr. API Reference button
  • docs: Add links to all Builder tasks in Standard Tasks table
  • refactor(internal/documentation): Remove of npm script jsdoc (deprecated & not used in CI)
    • Remove now unused dep open-cli

@maxreichmann

maxreichmann commented Jul 22, 2026

Copy link
Copy Markdown
Member Author

❗️ BLOCKED TILL #1453 IS MERGED

Pls dont start a review yet!

Edit Aug 13: Unblocked now

This PR includes the outsourced "Side tasks done" from original PR #1453.
Following changes have been made:

* docs: Replace hardcoded URLs (ui5.github.io/..) with dynamic links
* docs: Replace dead "API Reference" links
    * Guide the reader to use the new sidebar menu
    * Add "📚" emoji to "API" in sidebar to mimic depr. API Reference button
* docs: Add links to all Builder tasks in Standard Tasks table
* refactor(internal/documentation): Remove of npm script `jsdoc` (deprecated & not used in CI)
    * Remove now unused dep `open-cli`
@maxreichmann
maxreichmann marked this pull request as ready for review August 13, 2026 14:18
@maxreichmann
maxreichmann requested a review from a team August 13, 2026 14:19
// This function builds the tree for the api docs
const tree = {
text: "API",
text: "📚 API",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

So far, we do not use emojis for the sidebar headings. This would be the first and only one, so to me it now looks inconsistent. What do you think? I would also be interested in @KlattG's feedback on this PR.

@maxreichmann maxreichmann Aug 14, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

My idea behind this, was to still offer some kind of similar visual appearance, when the current "API Reference" button gets removed.

Current:
image

Now:
image

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.

2 participants