dagster-docs

Overview

Prerequisites

• Always ensure docs/node_modules exists before running any commands

  • Check first: Look for docs/node_modules/ directory
  • If missing: Run yarn install in /docs to install dependencies
  • Command: cd /docs; yarn install

• Always ensure docs/docs/api/**/*.mdx files exist before running yarn start

  • Check first: Look for docs/docs/api/**/*.mdx files
  • If missing: Run yarn build-api-docs in the docs root
  • Command: cd /docs; yarn build-api-docs

Related documentation

• Audiences: See audiences.md for descriptions of primary audiences.
• Formatting and style: See docs/docs/about/contributing-docs/formatting-style.md for formatting and style conventions.
• Content model: See docs/docs/about/contributing-docs/content-model for an explanation of the structure and types of content included in Dagster docs.