-
Notifications
You must be signed in to change notification settings - Fork 4
Toolbox 2017 Roadmap
To offer a more flexible, durable and maintainable styleguide, we decide to drop the generated styleguide out of the projects. Instead, we are going to use a “styleguide reader” built with React (check the poc ). The only thing that every project have to produce is an index.html
who list all the components and the data inside the ./build
directory. This directory will be used to display our styleguide on a gh-pages using the reader’s CDN.
This new interactive reader will offer all current features, Twig templating, better components presentation, components autocomplete (remember Cortana) and maybe a lot more in the feature like types & color settings.
Like react-scripts, all build tasks and processes will become a single project’s devDependency. All those tasks and command will be fire using npm scripts. With this approach, it will be easier to update our tasks for existing projects without refactoring everything.
Only the essential will remain inside the projects; styles (Sass), scripts (JS), components (Twig) and documentation.
As described earlier, all tasks will be externalized out of the generator’s template. If possible, a new task to update 2016+ projects will be added or, at least, a documented workflow to achieve it. A more HTTP2/modern file structure will appear with something like :
assets
└── components
├── atoms
│ └── button
│ ├── button.scss
│ ├── button.twig
│ ├── button_danger.twig
│ └── button.yml
├── mollecules
└── ...
After a year without any documentation, we will finally create one in a dedicated gh-pages.