Explore options for representing component descriptions
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Summary
Currently, the default tab in the CI/CD Catalog is set to "Components," which may clearly indicate technical details. For first-time users and those unfamiliar with the project, the "README" tab could provide a more accessible entry point by showcasing the functionality and context of the component.
We could consider an alternative approach, such as blending the content from both tabs and presenting them together on one page. This would provide a more comprehensive and accessible view, balancing the technical details with the broader context to improve the current experience for both new and returning users.
Definition of Done
Details
Roles involved
-
Design -
Technical Writing -
Backend -
Frontend -
Test engineering
NOTE: When work is ready to be defined, please create appropriate sub-tasks.