diff --git a/docs/getting-started-preparation.md b/docs/getting-started-preparation.md index 463399b0ec..4212ecd5fe 100644 --- a/docs/getting-started-preparation.md +++ b/docs/getting-started-preparation.md @@ -33,15 +33,31 @@ root-directory └── static ``` -> You may have already renamed the example blog (`website/blog-examples-from-docusaurus`) and document (`docs-examples-from-docusaurus`) directories when you [verified the installation](getting-started-installation.md##verifying-installation). +> You may have already renamed the example blog (`website/blog-examples-from-docusaurus` to `website/blog`) and document (`docs-examples-from-docusaurus` to `docs`) directories when you [verified the installation](getting-started-installation.md##verifying-installation). -* The `website/core/Footer.js` file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user. -* The `website/blog-examples-from-docusaurus` directory contains examples of blog posts written in markdown. -* The `docs-examples-from-docusaurus` directory contains example documentation files written in markdown. -* The `website/pages` directory contains example top-level pages for the site. -* The `website/static` directory contains static assets used by the example site. -* The `website/siteConfig.js` file is the main configuration file used by Docusaurus. +### Directory Descriptions -You will need to keep the `website/siteConfig.js` and `website/core/Footer.js` files, but may edit them as you wish. +* **Documentation Source Files**: The `docs-examples-from-docusaurus` directory + contains example documentation files written in Markdown. +* **Blog**: The `website/blog-examples-from-docusaurus` directory contains examples of blog posts written in markdown. +* **Pages**: The `website/pages` directory contains example top-level pages for the site. +* **Static files and images**: The `website/static` directory contains static assets used by the example site. -You should keep the `website/pages` and `website/static` directories, but may change the content inside them as you wish. At the bare minimum you should have an `en/index.js` or `en/index.html` file inside `website/pages` and an image to use as your header icon inside `website/static`. +### Key Files + +* **Footer**: The `website/core/Footer.js` file is a React component that acts + as the footer for the site generated by Docusaurus and should be customized by the user. +* **Configuration file**: The `website/siteConfig.js` file is the main + configuration file used by Docusaurus. +* **Sidebars**: The `sidebars.json` file contains the structure and ordering + of the documentation files. + +## Preparation Notes + +You will need to keep the `website/siteConfig.js` and `website/core/Footer.js` +files, but may edit them as you wish. + +You should keep the `website/pages` and `website/static` directories, but may +change the content inside them as you wish. At the bare minimum you should have +an `en/index.js` or `en/index.html` file inside `website/pages` and an image to +use as your header icon inside `website/static`.