Finish dev documentation of Design System

[daniellex0]

Overview

We need to complete the developer-facing documentation of the design system so that developers can easily pickup how and when to utilize reusable components

Action Items

• Wiki files and check if the flow makes sense
  • https://github.com/hackforla/website/wiki/Standardized-Components
  • https://github.com/hackforla/website/wiki/How-to-create-a-page-on-Hack-for-LA-website
  • https://github.com/hackforla/website/wiki/Hack-for-LA's-Site-Architecture#styling-files
• SCSS files - document clearer if needed
  • https://github.com/hackforla/website/blob/gh-pages/_sass/elements/_buttons.scss
  • https://github.com/hackforla/website/blob/gh-pages/_sass/elements/_cards.scss
  • Color variable/components
  • Typography class
• Figure out how to link GitHub SCSS file to the corresponding Figma component
• Create checklist
  • https://docs.google.com/document/d/1jQ9C52jfLPztB3hky01W5za8eGydxP7lnudCR64eXkw/edit?usp=sharing
  • Figure out what is redundant and the priority of what will be standardized in the near future
  • https://github.com/hackforla/website/tree/gh-pages/_sass
• Figma, Style Guide - Start Here, Dev
  • https://www.figma.com/file/0RRPy1Ph7HafI3qOITg0Mr/Hack-for-LA-Website?node-id=3464%3A3

Resources/Instructions

Design System on Figma
Standardized Components wiki
How to create a new page wiki

[daniellex0]

@daniellex0 , @qiqicodes , and @ruqpyL2 are working on this

[qiqicodes]

Progress: restructuring wiki navigation by categorizing. rewriting design component documents.

Blockers: @daniellex0 @ruqpyL2 @qiqicodes are meeting this week. Loop in @akibrhast when the meeting is happening.

ETA: TBD

[qiqicodes]

Progress: trying out UI component libraries, such as storybook, styleguidist, etc... to see which one fits our needs best
Blockers: need to arrange a meeting to discuss the tradeoffs

[qiqicodes]

Progress: Same progress
Blockers: Likely we will meet next week to discuss the tradeoffs

[daniellex0]

Progress: Heard about different way to approach wiki reorganization from Bonnie, but waiting for buy-in from dev team. Still figuring out feasibility of Storybook/Styleguidist vs. dedicated web page for component documentation
Blockers: Busy week for everyone

[daniellex0]

Progress: Moving forward with wiki reorganization and reformat. Still determining whether to have dedicated web page for component documentation
Blockers: Limited time
Next steps: Meeting this week about stylebook, move forward with making updates to wiki