About .cursorrules prompt file
What you can build
Dagster Tutorial Platform: A web-based platform that provides interactive Dagster tutorials using the Diataxis method. Users can explore different data engineering concepts through Python examples and Dagster workflows, improving their skills with hands-on exercises and real-world scenarios.
Docusaurus Documentation Generator: A service that automatically converts existing Dagster documentation into a Docusaurus-compatible format, leveraging key principles like modularization and clear, concise technical guidelines.
Dagster Asset Management Tool: An online service that simplifies the creation and management of Dagster assets using @asset decorators. It encourages type-safe workflow design through Pydantic models, providing users with tools to define and validate their data pipelines efficiently.
Data Engineering Codebase Analyzer: A desktop application that scans Python projects to identify areas where Dagster could be beneficially integrated. It suggests adopting best practices like using @asset decorators, Pydantic for input validation, and provides a report with code modularization opportunities.
Interactive Prerequisite Checker: A web app that helps Dagster users verify their permissions before accessing various features, ensuring they meet all prerequisite requirements. The platform lists the required permissions (e.g., Organization, Admin, or Editor) for specific actions within Dagster environments.
Markdown Code Formatter for Dagster: A plugin for text editors that formats code blocks according to Dagster and Python documentation standards, including embedding sample code in documented sections using a consistent and readable format, enhancing the clarity for developers.
Dagster Study Community Portal: A community-driven website where Dagster users can share guides, case studies, and code snippets. It includes a forum for discussing best practices, troubleshooting, and collaborative learning, fostering a dedicated community for Python and Dagster enthusiasts.
Python Variable Naming Helper: An AI-powered tool that suggests descriptive variable names with auxiliary verbs based on the context of a given code snippet. It helps maintain a consistent naming convention across Python data pipelines, enhancing code readability and maintainability.
Benefits
- Migrate Dagster docs to Docusaurus, using
/docsfor documentation and/src/componentsfor components. - Follow Diataxis Principle; use Docusaurus Markdown; provide technical, concise Python examples using type hints.
- Prefer @asset over @op in Dagster; incorporate
CodeExampleformat for guides.
Synopsis
Developers working with Dagster and Docusaurus would use this prompt to efficiently migrate documentation by following the Diataxis Principle and providing concise, accurate Python examples with correct syntax and structure.
Overview of .cursorrules prompt
The .cursorrules file outlines guidelines for migrating Dagster documentation to Docusaurus format, focusing on organizing documentation and components in specific directories. It emphasizes following the Diataxis principle, using Docusaurus Markdown, and including detailed guides with prerequisites and code examples. The file also provides coding standards for Python/Dagster, such as preferring @asset, using type hints, and adopting Pydantic models for input validation. Additionally, it specifies output formatting using markdown with code blocks.
