Skip to content
This repository has been archived by the owner on Aug 4, 2023. It is now read-only.

Documentation improvements #30

Open
generalredneck opened this issue May 20, 2021 · 0 comments
Open

Documentation improvements #30

generalredneck opened this issue May 20, 2021 · 0 comments

Comments

@generalredneck
Copy link

generalredneck commented May 20, 2021

In details/twig-extensions/README.md there is a note at the bottom.

Note: The attach_library Twig extension was deprecated in the latest version as Storybook has a better method for handling JavaScript. That function won't throw errors in Storybook, but it will not add your JavaScript. See components/02-molecules/tabs/tabs.stories.js for an example of how to add JavaScript for a component in Storybook.

That sounds like very important information for people whom had to upgrade. Should this be part of the upgrade steps?

In usage/writing-stories we put this

Writing components is still the same as it has always been in Emulsify (Create your component Twig/React, .scss and/or .js files.

The process of creating Twig js and scss files aren't explained in this documentation so there's no idea of the difference between what used to happen and now.

A lot of the documentation is written as "used to" or "in the old version" without really telling you how that is important or what changed.

What we lack is a quick start guide which has a high level list of the things you need to get started through the whole process of creating a theme.

What we also lack is resources that get you from 0 to hero... meaning there is nothing going step by step setting up or creating a theme in order. Resources like that should exist and should be linked in docs

Finally we should be writing out the assumptions we are making. Example... we assume that people are proficient at twig... if they aren't then suggesting a level they need to get to or a set of documentation would be a good start. Pointing then to the help section and interlinking our pages would be nice.

We assume everyone is comfortable as a react or nodejs developer. Drupal and WordPress specifically are PHP first which makes one coming from that world come into this unprepared. We expect you to live and breathe atomic design. That said... when I finally read the whole of our documentation we have
help/cdd which should be more prominent I think.

We also expect you to look at the examples to learn how to create new components organisms and stuff without explaining what is going on there. help/tutorials-videos tries to bridge this with minimal effort but needs updating as Evans videos are about emulsify 1.

The FAQ is light.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant