docs: mention about moving docs directory into website (#2103)

This commit is contained in:
Yangshun Tay 2019-12-08 20:35:22 -08:00 committed by GitHub
parent 55e676cb25
commit 2fcb81596b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 0 deletions

View file

@ -153,6 +153,8 @@ module.exports = {
};
```
We recommend moving the `docs` folder into the `website` folder and that is also the default directory structure in v2. [Now](https://zeit.co/now) supports [Docusaurus project deployments out-of-the-box](https://github.com/zeit/now-examples/tree/master/docusaurus) if the `docs` directory is within the `website`. It is also generally better for the docs to be within the website so that the docs and the rest of the website code are co-located within one `website` directory.
Refer to migration guide below for each field in `siteConfig.js`.
### Updated fields