Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guidelines documentation (elements packages) #841

Closed
alisonjoseph opened this issue Jan 23, 2020 · 2 comments
Closed

Guidelines documentation (elements packages) #841

alisonjoseph opened this issue Jan 23, 2020 · 2 comments
Labels
Epic Special label used by ZenHub for epic functionality type: docs 📖

Comments

@alisonjoseph
Copy link
Member

alisonjoseph commented Jan 23, 2020

Developer guidelines around how to use our elements packages are lacking or completely missing from the website.

  • Color
  • Icons
  • Pictograms
  • Motion
  • Typography

These pages need an "Implementation" tab added, similar to the Grid page (https://www.carbondesignsystem.com/guidelines/2x-grid/implementation) so a developer coming to the website will know how to use the packages in their code.

@alisonjoseph alisonjoseph added Epic Special label used by ZenHub for epic functionality type: docs 📖 labels Jan 23, 2020
@alisonjoseph alisonjoseph changed the title Guidelines documentation Guidelines documentation (elements packages) Feb 18, 2020
@alisonjoseph alisonjoseph self-assigned this Mar 5, 2020
@connor-leech
Copy link
Contributor

connor-leech commented Apr 7, 2020

To-do

  • Bring over README files into code tabs (or elements docs when applicable)
    • Colors
    • Grid
    • Icons
    • Layout
    • Themes
    • Type
    • Pictograms
  • Clean up readme docs
    • Colors
    • Grid
    • Icons
    • Layout
    • Themes
    • Type
    • Pictograms
  • Speak with Alison and Josh about each tab. What's missing? What does a dev need to know? Is any imagery missing?
    • Colors
    • Grid
    • Icons
    • Layout
    • Themes
    • Type
    • Pictograms
  • Get content review on all new pages
    • Colors
    • Grid
    • Icons
    • Layout
    • Themes
    • Type
    • Pictograms
  • Get design review on all new pages
    • Colors
    • Grid
    • Icons
    • Layout
    • Themes
    • Type
    • Pictograms

Questions

  • Why isn't layout on the website? Is that spacing instead? If so, they shouldn't be named the same thing.
  • Why do pictograms and icons have their own contribute tab? This isn't the same pattern as we follow elsewhere on the site.
    • How many icons are contributed via this link? We should add fathom tracking to those links.

@alisonjoseph alisonjoseph removed their assignment Jun 12, 2020
@janchild
Copy link
Contributor

janchild commented Aug 5, 2020

This work has been completed.

@janchild janchild closed this as completed Aug 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic Special label used by ZenHub for epic functionality type: docs 📖
Projects
None yet
Development

No branches or pull requests

3 participants