Make CodeExample block SSRd for better SEO.

[salazarm]

Summary & Motivation

We want to make sure that the CodeExample block is included in the statically generated HTML for the site so that it's included in SEO. Currently since we use a useEffect we only fetch the content on the client.

To fix this we need to make sure we have the content on the server. To this end I added a check to see if we're on the server and if we are then we synchronously require the content for the codeblock inline during render and use it. Otherwise, if we're on the client, we import the content dynamically and rely on Suspense to avoid unmounting the SSR'd content during the initial render.

How I Tested These Changes

yarn build
yarn serve

Looked at the source in view-source:http://localhost:3002/ and confirmed the HTML includes the codeblocks.

There's a brief flash of the light theme but confirmed on the docs-preview site that this is in an existing issue and unrelated to my approach.

Screen.Recording.2025-01-03.at.7.22.01.PM.mov

[github-actions]

Deploy preview for dagster-docs-beta ready!

Preview available at https://dagster-docs-beta-e0uv0a2po-elementl.vercel.app

Direct link to changed pages:

• https://dagster-docs-beta-e0uv0a2po-elementl.vercel.app/dagster-plus/deployment/deployment-types/serverless/runtime-environment

[salazarm]

One unexpected benefit of this approach is that we can now make invalid code examples cause the build to fail. I tried to fix a few but then realized some examples were just completely deleted (not just moved) so I wrapped the require call in try/catch. Once we fix those bad code examples we should remove the try/catch.

Here are the bad examples (cc @neverett):

Error: Cannot find module './docs_beta_snippets/docs_beta_snippets/guides/automation/multi-asset-sensor.py'

Error: Cannot find module './docs_beta_snippets/docs_beta_snippets/guides/build/create-asset-pipelines/data-assets/quality-testing/asset-checks/single-asset-check.py'

Error: Cannot find module './docs_beta_snippets/docs_beta_snippets/guides/build/create-asset-pipelines/data-assets/quality-testing/asset-checks/multiple-asset-checks.py'

Error: Cannot find module './docs_beta_snippets/docs_beta_snippets/guides/build/create-asset-pipelines/data-assets/quality-testing/asset-checks/asset-checks-factory.py'

Error: Cannot find module './docs_beta_snippets/docs_beta_snippets/guides/build/create-asset-pipelines/data-assets/quality-testing/asset-checks/block-downstream-with-asset-checks.py'

Error: Cannot find module './docs_beta_snippets/docs_beta_snippets/guides/build/create-asset-pipelines/data-assets/quality-testing/asset-checks/asset-checks-with-schedule-and-sensor.py'