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

[docs][guides] Other CSS Frameworks and Libraries page #21541

Closed
3 tasks
marcysutton opened this issue Feb 18, 2020 · 3 comments · Fixed by #26087
Closed
3 tasks

[docs][guides] Other CSS Frameworks and Libraries page #21541

marcysutton opened this issue Feb 18, 2020 · 3 comments · Fixed by #26087
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@marcysutton
Copy link
Contributor

marcysutton commented Feb 18, 2020

Summary

Add a new Reference Guide to the CSS Libraries and Frameworks section for "Other Libraries" and mention Bootstrap, Material UI, Reach UI, Grommet, etc. We do NOT want to list every UI library, as that would be impossible to maintain.

Here are the criteria for what should be listed on this page:

  • Works with React and Gatsby
  • Impacts styling of a Gatsby site (to fit in the parent section)
  • Commonly requested or searched in the Gatsby docs (the Gatsby team has the most insight into this part)
  • Considers accessibility and does not promote UI anti-patterns

This initial list includes:

  • Grommet
  • Chakra UI
  • Material UI
  • Bootstrap (including how to use the optional JS code which includes jQuery)

This could possibly include Reach UI, but that project intentionally leaves styling out of the framework so it might not fit in this section.

Motivation

As part of #21278, we want to add a page to the docs that provides a short and curated list of CSS/UI libraries. We don't want to maintain individual pages for all libraries, so this is a bit of a catch-all page where we can list libraries with a link and a short paragraph about each one.

Draft the doc

Open a pull request

@marcysutton marcysutton added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Feb 18, 2020
@wardpeet
Copy link
Contributor

I'm mostly wondering why the provided list? Is this somehow we feel the community is using the most? It's a good list, just wondering :)

@marcysutton
Copy link
Contributor Author

Hey @wardpeet, just seeing your comment now. This is mostly in response to common Algolia searches without results, and other discovery around the web. A curated page like this will allow us to add content about commonly searched terms without dedicating entire pages to them.

@marcysutton marcysutton added the help wanted Issue with a clear description that the community can help with. label Apr 18, 2020
@meganesu
Copy link
Contributor

meganesu commented Jul 28, 2020

Hi there @marcysutton, I'd like to give this one a go, if that's alright?

One clarifying question before I get started: could you give some more context on what this bullet point means? Wait never mind, I get it now!

Impacts styling of a Gatsby site (to fit in the parent section)

Thanks!

@AishaBlake AishaBlake added status: community assigned and removed help wanted Issue with a clear description that the community can help with. labels Jul 29, 2020
@LekoArts LekoArts removed the not stale label Sep 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants