docs: add "Have It Your Way" plugin dev note#608
Conversation
|
Docs preview: https://a5eb01eb.dd-docs-preview.pages.dev
|
c49880f to
aae652e
Compare
Greptile SummaryThis PR adds a new "Have It Your Way" dev note documenting the Data Designer plugin framework, along with supporting CSS utilities and a navigation update in
|
| Filename | Overview |
|---|---|
| docs/devnotes/posts/have-it-your-way.md | New dev note introducing the plugin framework; all internal relative links resolve correctly to existing files in docs/plugins/ and docs/recipes/plugin_development/. |
| docs/css/style.css | Adds reusable devnote-dek, devnote-float-right, devnote-section-graphic, devnote-clear, and devnote-hide-in-index classes with appropriate responsive breakpoint handling at 60em. |
| mkdocs.yml | Adds new dev note to nav, removes unnecessary quotes from two existing nav labels, and removes url_download: true from the snippets extension (addressing a previously raised concern). |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User installs plugin package] --> B[Entry point registers Plugin descriptor]
B --> C{Data Designer discovers plugin}
C --> D[Seed Reader Plugin\nMarkdownSectionSeedSource]
C --> E[Column Generator Plugin\ncustom column types]
C --> F[Processor Plugin\nexport / transform]
D --> G[build_manifest\nlight index of candidates]
G --> H[hydrate_row\nparse & fan-out selected rows]
E --> I[generate column values\nduring dependency ordering]
F --> J[transform records\nbefore or after generation]
H --> K[Data Designer pipeline\nvalidation · batching · model calls · output]
I --> K
J --> K
Reviews (3): Last reviewed commit: "docs: remove unused snippet URL download..." | Re-trigger Greptile
Introduces a dev note covering Data Designer's plugin framework: seed reader, column generator, and processor extension points, with packaging and entry-point examples.
YAML does not require quoting these titles — removing them keeps the nav entries consistent with the surrounding lines.
- Refine the intro, customization, and authoring sections - Add wrapped devnote imagery and shared image styling - Link readers to plugin implementation references
f3bd9b9 to
9dbb9e5
Compare
nabinchha
left a comment
There was a problem hiding this comment.
Added one minor comment/question. Also should this post mention custom column generator somewhere?
|
|
||
| from typing import Literal | ||
|
|
||
| from data_designer.config.seed_source import FileSystemSeedSource |
There was a problem hiding this comment.
should we encourage the dd pattern here too?
import data_designer.config as dd
class MarkdownSectionSeedSource(dd.FileSystemSeedSource):
Summary
Adds a new dev note introducing Data Designer's plugin framework now that plugins have graduated out of experimental mode. The PR is now rebased onto
mainand targetsmaindirectly instead of the former stacked plugin-docs branch.Changes
Added
Changed
Attention Areas
Description updated with AI