search

Shopify / slate

Slate is a toolkit for developing Shopify themes. It's designed to assist your workflow and speed up the process of developing, testing, and deploying themes.
https://shopify.github.io/slate
MIT License
1.28k stars 365 forks source link

Add documentation website #910

Closed huguestennier closed 5 years ago

huguestennier commented 5 years ago

What are you trying to accomplish with this PR?

In an effort to improve the quality of our Docs, we are moving from GitHub's Wiki to use our own documentation website.

This effort will open up the possible contributions by the community while also giving us a better control on reviews and what get published.

This is also of our first opportunity to push Slate's branding forward.

It will be hosted using GitHub pages and the /docs folder on the master branch.

Documentation website preview

dan-gamble commented 5 years ago

This is awesome @huguestennier. This will definitely help Slate push forward and further it's adoption 👏.

For starters this will be a much nicer place to link to than Github's Wiki.

t-kelly commented 5 years ago

@huguestennier are there any files in particular you want reviewed?

t-kelly commented 5 years ago

Also let's merge https://github.com/Shopify/slate/pull/914 before we merge this PR

huguestennier commented 5 years ago

@huguestennier are there any files in particular you want reviewed?

Nothing specific, if the preview website make sense then we should be good to go.

I added a very small custom script to highlight the section you're reading if you want to see here : https://github.com/Shopify/slate/blob/175ff3c8af2a8be4399b010401cc71e41bd3e310/docusaurus/v1/build/slate/js/custom.js

But other than that it's pretty default configuration

t-kelly commented 5 years ago

🚢

lock[bot] commented 5 years ago

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.