Update beta-docs README and CONTRIBUTING

docs/docs-beta/CONTRIBUTING.md

@@ -98,3 +98,34 @@ _There is not a replacement at this point in time..._
 ### Whitespace via `{" "}`
 
 Forcing empty space using the `{" "}` interpolation is not supported, and must be removed.
+
+## Diagrams
+
+You can use [Mermaid.js](https://mermaid.js.org/syntax/flowchart.html) to create diagrams. For example:
+
+```mermaid
+flowchart LR
+    Start --> Stop
+```
+
+Refer to the [Mermaid.js documentation](https://mermaid.js.org/) for more info.
+
+## Code examples
+
+To include code snippets, use the following format:
+
+```
+<CodeExample filePath="path/to/file.py" />
+```
+
+The `filePath` is relative to the `./examples/docs_beta_snippets/docs_beta_snippets/` directory.
+
+At minimum, all `.py` files in the `docs_beta_snippets` directory are tested by attempting to load the Python files.
+You can write additional tests for them in the `docs_beta_snippets_test` folder. See the folder for more information.
+
+To type-check the code snippets during development, run the following command from the Dagster root folder.
+This will run `pyright` on all new/changed files relative to the master branch.
+
+```
+make quick_pyright
+```

docs/docs-beta/README.md

@@ -5,6 +5,26 @@ The documentation site is built using [Docusaurus](https://docusaurus.io/), a mo
 
 ---
 
+## Overview of the docs
+
+- `./src` contains custom components, styles, themes, and layouts.
+- `./content-templates` contains the templates for the documentation pages.
+- `./docs/` is the source of truth for the documentation.
+- `/examples/docs_beta_snippets/docs_beta_snippets/` contains all code examples for the documentation.
+
+The docs are broken down into the following sections:
+
+- Docs - includes content from [getting-started](./docs/getting-started/) and [guides](./docs/guides/)
+- [Integrations](./docs/integrations/)
+- [Dagster+](./docs/dagster-plus/)
+- [API reference](./docs/api/)
+
+`sidebar.ts` and `docusaurus.config.ts` are the main configuration files for the documentation.
+
+For formatting guidelines, see the [CONTRIBUTING](CONTRIBUTING.md) guide.
+
+---
+
 ## Installation
 
 The site uses [yarn](https://yarnpkg.com/) for package management.
@@ -31,22 +51,6 @@ pip install vale
 
 ---
 
-## Overview of the docs
-
-- `./src` contains custom components, styles, themes, and layouts.
-- `./content-templates` contains the templates for the documentation pages.
-- `./docs/` is the source of truth for the documentation.
-- `/examples/docs_beta_snippets/docs_beta_snippets/` contains all code examples for the documentation.
-
-The docs are broken down into the following sections:
-
-- [Tutorials](./docs/tutorials/)
-- [Guides](./docs/guides/)
-
-`sidebar.ts` and `docusaurus.config.ts` are the main configuration files for the documentation.
-
----
-
 ## Local Development
 
 To start the local development server:
@@ -72,37 +76,6 @@ yarn vale /path/to/file      ## check individual file
 yarn vale --no-wrap          ## remove wrapping from output
 ```
 
-### Diagrams
-
-You can use [Mermaid.js](https://mermaid.js.org/syntax/flowchart.html) to create diagrams. For example:
-
-```mermaid
-flowchart LR
-    Start --> Stop
-```
-
-Refer to the [Mermaid.js documentation](https://mermaid.js.org/) for more info.
-
-### Code examples
-
-To include code snippets, use the following format:
-
-```
-<CodeExample filePath="path/to/file.py" />
-```
-
-The `filePath` is relative to the `./examples/docs_beta_snippets/docs_beta_snippets/` directory.
-
-At minimum, all `.py` files in the `docs_beta_snippets` directory are tested by attempting to load the Python files.
-You can write additional tests for them in the `docs_beta_snippets_test` folder. See the folder for more information.
-
-To type-check the code snippets during development, run the following command from the Dagster root folder.
-This will run `pyright` on all new/changed files relative to the master branch.
-
-```
-make quick_pyright
-```
-
 ---
 
 ## Build
@@ -115,6 +88,8 @@ yarn build
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service. This also checks for any broken links in the documentation. Note that you will need to store Algolia credentials in local environment variables to build the site for production.
 
+---
+
 ## Deployment
 
 This site is built and deployed using Vercel.
@@ -129,6 +104,8 @@ yarn sync-api-docs && yarn build
 
 This runs the `scripts/vercel-sync-api-docs.sh` script which builds the MDX files using the custom `sphinx-mdx-builder`, and copies the resulting MDX files to `docs/api/python-api`.
 
+---
+
 ## Search
 
 Algolia search is used for search results on the website, as configured in `docusaurus.config.ts`.