Contrib.social

Improve stories and Auto-Docs for Atomic components + integrate with Varbase Figma project Stylesheet

Open on Drupal.org →
Created on 6 September 2023, over 1 year ago
Updated 5 October 2023, over 1 year ago

Problem/Motivation

Having may components, But no stories yet.
Only some of them.

Proposed resolution

Improve stories for atoms
Have the following list of items for each atomic

  • Properties ( Drupal's variables ( some time forced to have), Module's variables, and Extra Bootstrap ~5.3.0 variants over components
  • Attributes ( Drupal's Attributes, or custom needed attributes for the component ( for better twig rendering practices.
  • Slots (Regions, which HTML content or other components could be included, embedded, or extended ) This could be passed by Drupal twig templates, or from the UI, or hard coded in twig templates.

Auto-Doc Storybook documentation page.

Remaining tasks

  • ✅ File an issue about this project
  • ✅ Addition/Change/Update/Fix to this project
  • ✅ Testing to ensure no regression
  • ➖ Automated unit/functional testing coverage
  • ➖ Developer Documentation support on feature change/addition
  • ➖ User Guide Documentation support on feature change/addition
  • ✅ Accessibility and Readability
  • ✅ Code review from 1 Varbase core team member
  • ✅ Full testing and approval
  • ✅ Credit contributors
  • ✅ Review with the product owner
  • ✅ Update Release Notes and Update Helper on new feature change/addition
  • ✅ Release varbase-10.0.0-beta2 → , varbase_components-2.0.0-alpha22 →

Varbase update type

  • ✅ No Update
  • ➖ Optional Update
  • ➖ Forced Update
  • ➖ Forced Update if Unchanged

User interface changes

  • N/A

API changes

  • N/A

Data model changes

  • N/A

Release notes snippet

  • Issue #3385546 → : Improved stories and Auto-Docs for Atomic components + integrate with Varbase Figma project Stylesheet
📌 Task
Status

Fixed

Version

2.0

Component

Code

Created by

🇯🇴Jordan Rajab Natshah Jordan

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024