search

solid-design-system / solid

Monorepo for Union Investment's Solid Design System.
https://solid-design-system.fe.union-investment.de/docs/
Other
21 stars 4 forks source link

docs: improve FAQ #1424

Closed Vahid1919 closed 1 month ago

Vahid1919 commented 1 month ago

Description:

Closes #1116. Moved @miguelxnxn changes to a branch.

Definition of Reviewable:

miguelxnxn commented 1 month ago

Hey @solid-design-system/core-design @solid-design-system/core-development the following is a suggested categorisation for the FAQs. Does this make sense to you? Do you have any optimisation suggestions?

(Please note that the original wording for some questions has been adapted for consistency reasons)

1. Overview and Principles What is the Solid Design System? What benefits does the Solid Design System provide? What are the three core principles of the Solid Design System? What do we offer, and what falls outside our scope?

2. Usage and Implementation How should I use the Solid Design System and why? What are the differences between components, styles and templates in our library? Are there tutorials or guides available for beginners? Where can I find mobile components? Does using the Solid Design System guarantee my website’s accessibility? Can I use the Solid Design System for my private projects? How does the Solid Design System work with different Figma Teams and Figma Workspaces? Why do we rely on basic HTML standards? Which browsers are supported? Does the Solid Design System support TypeScript and work with React, Vue, and Angular? Can I download assets or code snippets directly from the documentation?

3. Support and Contribution How can I contact the Solid Design System team? How can I contribute to the Solid Design System? Is there a roadmap for upcoming features? How can I submit a feature request or report a bug? Who is working on the Solid Design System? Will the development of the Solid Design System ever be complete?

4. Advanced Topics and Customization What is the story behind “Design Tokens”? Why aren’t all the features I need for my project included in the Solid Design System? Can I customize the appearance of Solid Design System components? Do I need to create a project-specific component library? What is the suggested workflow between Design and Development in project-specific teams?

coraliefeil commented 1 month ago

I already synced with Miguel last Wednesday. IMO the clusters suggested are great.

karlbaumhauer commented 1 month ago

Hey @solid-design-system/core-design @solid-design-system/core-development the following is a suggested categorisation for the FAQs. Does this make sense to you? Do you have any optimisation suggestions?

(Please note that the original wording for some questions has been adapted for consistency reasons)

1. Overview and Principles

  • [x] What is the Solid Design System?
  • [x] What benefits does the Solid Design System provide?
  • [x] What are the three core principles of the Solid Design System?
  • [x] What do we offer, and what falls outside our scope?

2. Usage and Implementation

  • [x] How should I use the Solid Design System and why?
  • [x] What are the differences between components, styles and templates in our library?
  • [x] Are there tutorials or guides available for beginners?
  • [ ] Where can I find mobile components?
  • [x] Does using the Solid Design System guarantee my website’s accessibility?
  • [x] Can I use the Solid Design System for my private projects?
  • [x] How does the Solid Design System work with different Figma Teams and Figma Workspaces?
  • [x] Why do we rely on basic HTML standards?
  • [x] Which browsers are supported?
  • [x] Does the Solid Design System support TypeScript and work with React, Vue, and Angular?
  • [x] Can I download assets or code snippets directly from the documentation?

3. Support and Contribution

  • [x] How can I contact the Solid Design System team?
  • [x] How can I contribute to the Solid Design System?
  • [x] Is there a roadmap for upcoming features?
  • [x] How can I submit a feature request or report a bug?
  • [x] Who is working on the Solid Design System?
  • [x] Will the development of the Solid Design System ever be complete?

4. Advanced Topics and Customization

  • [x] What is the story behind “Design Tokens”?
  • [x] Why aren’t all the features I need for my project included in the Solid Design System?
  • [x] Can I customize the appearance of Solid Design System components?
  • [x] Do I need to create a project-specific component library?
  • [x] What is the suggested workflow between Design and Development in project-specific teams?
karlbaumhauer commented 1 month ago

@miguelxnxn I fixed all our issues (spacings, font styles, rephrase last question and removed the emojis). pls have another look on the feature branch and let me know if something is missing.

The text styles (bold, italic etc) and the mobile designs questions is still missing.

karlbaumhauer commented 1 month ago

as agreed with @coraliefeil I will merge this now and wait for the final design review to refactor it again.