// Expert guidance for writing documentation for the Dagster docs website. ALWAYS use before creating or updating documentation in the docs directory.
| name | dagster-docs |
| description | Expert guidance for writing documentation for the Dagster docs website. ALWAYS use before creating or updating documentation in the docs directory. |
Always ensure docs/node_modules exists before running any commands
docs/node_modules/ directoryyarn install in /docs to install dependenciescd /docs; yarn installAlways ensure docs/docs/api/**/*.mdx files exist before running yarn start
docs/docs/api/**/*.mdx filesyarn build-api-docs in the docs rootcd /docs; yarn build-api-docsaudiences.md for descriptions of primary audiences.docs/docs/about/contributing-docs/formatting-style.md for formatting and style conventions.docs/docs/about/contributing-docs/content-model for an explanation of the structure and types of content included in Dagster docs.docs/docs/aboutAll
docs/docs/about/changelog.md is automatically populated from /CHANGES.md through a custom React component. Do not edit changelog.md directly.
docs/docs/api.mdx files are generated from .rst files in
docs/sphinx/sections/api and should not be directly edited. Instead, update the .rst file or the docstrings in /python_modules.
docs/docs/dagster-basics-tutorialdocs/docs/deploymentdocs/docs/examplesdocs/docs/examples/full-pipelines/blueskydocs/docs/getting-starteddocs/docs/guidesMost subdirectories in docs/docs/guides correspond to phases in the data engineering lifecycle:
pdb.The docs/docs/guides/labs subdirectory contains documentation of new features under active development. All pages in the Labs section should import the early access partial and reference it at the top of the page.
The docs/docs/partials subdirectory contains files with text that is referenced in multiple places throughout the documentation.
docs/docs/guides/build/assets/asset-selection-syntaxdocs/docs/guides/automate/declarative-automationdocs/docs/integrations.mdx files are generated from .rst files in sphinx/sections/integrations and should not be directly edited. Instead, update the corresponding .rst file. Docstrings for classes and modules in corresponding files in python_modules/libraries may also need to be updated.docs/docs/integrations/libraries/databricksdocs/docs/integrations/libraries/fivetrandocs/docs/migrationdocs/docs/migration/upgrading.md is automatically populated by /MIGRATION.md through a custom React component. Do not edit upgrading.md directly.yarn start in /docs directory