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

[RFC] - UI Shell: missing guidance/blog ideas #2742

Closed
jnm2377 opened this issue May 15, 2019 · 0 comments
Closed

[RFC] - UI Shell: missing guidance/blog ideas #2742

jnm2377 opened this issue May 15, 2019 · 0 comments

Comments

@jnm2377
Copy link
Contributor

jnm2377 commented May 15, 2019

Overview:
This is an audit of existing and missing docs for UI Shell. A lot of these need to be added to our site docs, but the main points could also be individual blog posts that address the more detailed questions in them.


Legend:

✅ - already documented on our site
🚫 - no current documentation
⚠️ - documented on our site but needs more detailed guidance
🖥 - blog post


Ideas:

  • 🖥 ✅ What UI shell components do we offer? (could probably be more clear if we decide to separate each component into their own component page for documentation purposes rather than have it all under “UI Shell”)
    • 🚫 What browsers/frameworks does UI shell support?
    • 🚫 How did we integrate a11y into UI shell?
    • 🚫 Are there different themes available for the shell? (if not, is it coming or will it always be dark?)
  • 🖥 🚫 What header variations do we have?
    • 🚫 What is the difference between each variation (design/pattern/ux/intent wise)
    • 🚫 What is the default/Carbon recommended header? (and why did we choose this?)
    • 🚫 When should each variation be used?
  • 🖥 Patterns:
    • 🚫: Text overflow patterns / text length patterns (primarily a concern for long link names, will we support text wrap or text truncation?)
    • ⚠️ Responsiveness patterns (i.e. when should a top nav turn into a hamburger menu?)
    • ⚠️ icon placement patterns
    • 🚫 login/authentication patterns

More specific:

  • 🖥 🚫 How to use UI Shell with react-router-dom/ Link
  • 🖥 Step by step tutorial of implementing full shell (this time with more than just header)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant