Skip to content

Conversation

@guoda-puidokaite
Copy link
Contributor

@guoda-puidokaite guoda-puidokaite commented Jan 27, 2026

Summary

Enhance documentation of all UI Components in the editor, providing descriptions for all components and their props

Before

Screenshot 2026-01-27 at 11 25 54 Screenshot 2026-01-27 at 11 25 19

After

Screenshot 2026-01-27 at 11 21 53 Screenshot 2026-01-27 at 11 23 43

Changes Made

  • Added descriptions for all components, explaining their use
  • Added descriptions for all props, including defaults

Related Issues

Closes #1429

Checklist

  • I have performed a self-review of my code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • I have made corresponding changes to the documentation (if applicable).
  • My changes generate no new warnings or errors.
  • I have created a changeset for my changes.

PR Manifesto

Review the PR Manifesto for best practises.

@guoda-puidokaite guoda-puidokaite self-assigned this Jan 27, 2026
@guoda-puidokaite guoda-puidokaite requested review from a team and franzheidl as code owners January 27, 2026 10:27
@guoda-puidokaite guoda-puidokaite added documentation Improvements or additions to documentation package All tasks related to package under packages/ ui-components All tasks related to juno-ui-components library labels Jan 27, 2026
@changeset-bot
Copy link

changeset-bot bot commented Jan 27, 2026

🦋 Changeset detected

Latest commit: 7c6a670

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages
Name Type
@cloudoperators/juno-ui-components Patch
@cloudoperators/juno-app-carbon Patch
@cloudoperators/juno-app-doop Patch
@cloudoperators/juno-app-example Patch
@cloudoperators/juno-app-greenhouse Patch
@cloudoperators/juno-app-heureka Patch
@cloudoperators/juno-app-supernova Patch
@cloudoperators/juno-app-template Patch
@cloudoperators/juno-messages-provider Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions
Copy link
Contributor

PR Preview Action v1.6.3

🚀 View preview at
https://cloudoperators.github.io/juno/pr-preview/pr-1428/

Built to branch gh-pages at 2026-01-27 10:28 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Copy link
Collaborator

@ArtieReus ArtieReus left a comment

Choose a reason for hiding this comment

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

Just putting it into that state so I can suggest you something before. I hope it is fine :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation package All tasks related to package under packages/ ui-components All tasks related to juno-ui-components library

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Task](ui): improve developer docs by adding component and prop descriptions

3 participants