-
Notifications
You must be signed in to change notification settings - Fork 68
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
Update and add missing info and pages to the docs #386
Comments
Looks great, I like the direction it is heading. I've seen some questions about how to use styled components with grommet and it might be nice to share some best practices and examples on how the two works side by side. I'm also thinking maybe an Accessibility focus page that can contain the grommet's best practices for accessibility or the grommet's roadmap for accessibility improvements. It can demonstrate our strong intent on improving accessibility. One last thing that comes to my head is Testing, and maybe we'd like to add a page that lists our current testing mechanisms (snapshots jest/chromatic, axe-tests, ts testing...) most importantly list any current gaps in testing that will be open to ideas or contributions, areas such as Keyboard navigation, in-depth functional testing, any tsx gaps and more... |
Yes I agree. Right now I have styled components info organized under the theming page. But I considering if styled components should be a separate page.
Love this idea! I think it would be great to give a little info on accessibility within grommet, and possibly link to some external accessibility sources.
I'm wondering if we should just add more to the testing section in the contributing guide? Or do you see value in having a separate page for testing? |
Based on feedback from the community there are some gaps in our documentation and places where the docs are out of date and should be updated. Ideally we should have doc pages for each of the topics below. Some of these pages already exist and just need updated.
Tutorial
Status: Already exists, needs updated
Link: https://github.com/grommet/grommet-starter-new-app
Theming
Status: Already exists, needs updated
Link: https://github.com/grommet/grommet/wiki/Grommet-v2-theming-documentation
We should include information on the following:
Need to update the following:
Color properties
Status: Already exists, needs updated
Link: https://github.com/grommet/grommet/wiki/Color-Properties
Responsive behavior
Status: Doc doesn't exist
Internationalization
Status: Doc doesn't exist
We should include explanations on the following:
The text was updated successfully, but these errors were encountered: