Automated documentation and integration

Documentation component

  • Props Reader
  • Events Reader
  • Slots Display
  • Link to Bootstrap Components
  • Support Enums
  • Support Additional descriptions
  • Show if fully styled or not
  • Show validations
  • Import Line
  • Add description about documentation Info

Sample Component

  • Render Sample
  • Foldable Code
  • Foldable Output
  • Sample Selector
  • Build
  • Fix Source on design view
  • Reactivate Jest Snapshot Tests
  • New Documentation/Folder Structure (documentation file)
  • Update all components with new structure
  • Example Explorer - no examples

Nice to have

  • Examples for all components in new format
  • Link to source in documentation component
  • Show All/Show Single Example
  • Do Visual Regression testing on example files

design.gitlab.com

  • Import in design.gitlab.com
  • Show tabs for existing components
  • Full SPA URL's
  • Inclusion of Frontmatter files
  • Fix application.css inclusion
  • Fix deep Linking
  • Multiple Vue Controls per Design page

Nice to have

  • Build Tree dynamically
  • Show available components in Navigation
  • All Component MD's
  • Show Related Components
  • Components Overview Table (Status)
  • Shortcuts (Icons, Colors, etc.)
  • Todo Boxes

Live Editing

  • Supports Knobs
  • Connect to Sample
  • Live Editor

Future Ideas

  • Edit description Button
  • Direct to Web IDE
Edited by Paul Gascou-Vaillancourt