diff --git a/book/README.md b/book/README.md index 0c6c2c27b..fa7d79fce 100644 --- a/book/README.md +++ b/book/README.md @@ -24,18 +24,11 @@ $ yarn build This command generates static content into the `build` directory and can be served using any static contents hosting service. -### Deployment - -Using SSH: - -``` -$ USE_SSH=true yarn deploy -``` - -Not using SSH: - -``` -$ GIT_USER= yarn deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +### Maintenance Notes + +- Always run `npm build` locally first to ensure that the website builds correctly. +- When adding new pages, ensure that the sidebar is updated in `sidebars.ts`. +- Check you links, if you're pointing at an .mdx file, you need to omit the extension in the link. +- Code snippets from the repo are made through the [gen script](./gen-code-refs.sh). + - When adding new code snippets, ensure that the gen script is updated to include the new file. +- Check out the [Docusaurus documentation](https://docusaurus.io/docs/versioning) versioning information.