Skip to content
This repository has been archived by the owner on Jul 19, 2021. It is now read-only.

Add documentation website #910

Merged
merged 9 commits into from
Dec 17, 2018
Merged

Add documentation website #910

merged 9 commits into from
Dec 17, 2018

Conversation

huguestennier
Copy link
Contributor

@huguestennier huguestennier commented Dec 11, 2018

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
Copy link
Contributor

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
Copy link
Contributor

t-kelly commented Dec 13, 2018

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

@t-kelly
Copy link
Contributor

t-kelly commented Dec 13, 2018

Also let's merge #914 before we merge this PR

@huguestennier
Copy link
Contributor Author

@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

Copy link
Contributor

@t-kelly t-kelly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI is failing. You should add these folders to the .eslintignore

@t-kelly
Copy link
Contributor

t-kelly commented Dec 14, 2018

🚢

@huguestennier huguestennier merged commit ce18bac into master Dec 17, 2018
@lock
Copy link

lock bot commented Jan 16, 2019

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.

@lock lock bot locked as resolved and limited conversation to collaborators Jan 16, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants