Skip to content

Add Prompt Library section to Kedro docs #5146

@rashidakanchwala

Description

@rashidakanchwala

Description

We want to introduce a Prompt Library in the Kedro documentation as a living resource for users who want to apply LLMs to common Kedro workflows.

The idea is to provide ready-to-use, minimal prompts that users can copy, paste, and adapt directly in their projects. This will be a starting point that we improvise and expand over time based on community feedback and usage.

Context

The Kedro docs already explain best practices (e.g., secure credentials, dataset versioning, pipeline modularity).

The Prompt Library is different because:

  • It doesn’t just restate best practices → it shows how to apply them to a user’s actual project.
  • LLMs can take two inputs at once: Kedro’s rules (from docs/training) + the user’s own project files.

This enables the LLM to:

  • Detect anti-patterns and misconfigurations
  • Suggest corrections in YAML, Python, or hooks directly
  • Rewrite user code/config to follow Kedro standards

The result: personalized, actionable fixes, not just generic advice.

Initial Use Cases (MVP)

  • Apply Best Practices
    • Data Catalog → “Check my catalog.yml against Kedro best practices and suggest corrections.”
    • Config → “Audit my conf/base and conf/local configs for clean separation and security.”
    • Nodes/Pipelines → “Review my pipeline/nodes for structure, clarity, and Kedro standards.”
  • Testing
    • Create unit tests for my Kedro project → “Write pytest tests for my nodes and pipelines.”
  • Migration
    • Migrate my project from Kedro 0.18 to Kedro 0.19 → “Update datasets, settings, and hooks to the latest version.”
  • Deployment
    • Apply deployment best practices → “Suggest how to configure my Kedro project to work with Airflow (DAG skeleton, configs, Docker).”
  • Audit
    • Scan my project for anti-patterns → “Check configs, catalog, and pipelines against Kedro guidelines.”
  • Notebook Conversion
    • Convert my notebook to a Kedro project → “Transform this notebook into a Kedro project scaffold (v).”

Metadata

Metadata

Assignees

No one assigned

    Labels

    Issue: Feature RequestNew feature or improvement to existing feature

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions