docs: add "Have It Your Way" plugin dev note#608
Conversation
|
MkDocs preview: https://06ffdba6.dd-docs-preview.pages.dev Fern preview: https://nvidia-preview-pr-608.docs.buildwithfern.com/nemo/datadesigner
|
c49880f to
aae652e
Compare
Greptile SummaryThis PR adds a new "Have It Your Way" dev note introducing Data Designer's plugin framework now that plugins have graduated from experimental, along with reusable CSS helpers for devnote image layout and the removal of the experimental warning banners from the plugin reference pages.
|
| Filename | Overview |
|---|---|
| docs/devnotes/posts/have-it-your-way.md | New dev note introducing the plugin framework. Well-structured, but the impl.py code example calls extract_markdown_sections() which is neither imported nor defined anywhere in the shown snippet. |
| fern/versions/v0.5.8/pages/devnotes/posts/have-it-your-way.mdx | Fern mirror of the dev note. Same extract_markdown_sections() issue as the MkDocs version; also has a minor import order difference vs. the MkDocs counterpart. |
| docs/css/style.css | Adds devnote-dek, devnote-float-right, devnote-section-graphic, and devnote-clear helper classes plus a mobile responsive breakpoint; no issues found. |
| fern/versions/v0.5.8/pages/plugins/overview.mdx | Removes experimental warning banner and refreshes the intro paragraph and plugin type descriptions; clean change. |
| mkdocs.yml | Adds have-it-your-way nav entry at the correct most-recent-first position. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User installs plugin package] --> B[Entry point registered\nvia pyproject.toml]
B --> C[Data Designer discovers\nplugin at startup]
C --> D[User imports plugin\nconfig class]
D --> E[User adds to\nDataDesignerConfigBuilder]
E --> F{Plugin type?}
F -->|Seed Reader| G[build_manifest\nhydrate_row]
F -->|Column Generator| H[generate column\nwith dependency ordering]
F -->|Processor| I[transform records\nbefore/after generation]
G --> J[Data Designer executes\nnormal workflow]
H --> J
I --> J
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 1
docs/devnotes/posts/have-it-your-way.md:231-255
**`extract_markdown_sections` is undefined in the shown code**
The `impl.py` block is framed as a walkthrough of a complete file, but `extract_markdown_sections` is called without being imported or defined anywhere in the snippet. A reader copying this code would get a `NameError` immediately. The prose does note "the parser can still be a normal helper function," but there is no indication of where that function comes from — whether it should be defined earlier in `impl.py`, imported from a sibling module, or supplied by the user. The same gap exists in the Fern mirror at `fern/versions/v0.5.8/pages/devnotes/posts/have-it-your-way.mdx`. Adding a brief comment inside the code block or a preceding prose sentence pointing readers to the recipe link for the complete version would resolve the ambiguity.
Reviews (10): Last reviewed commit: "docs: link v0.6.0 release" | Re-trigger Greptile
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?
806c94a to
4bc9834
Compare
|
Thanks @nabinchha, good call. I added a short note at the end of the “Where Plugins Fit” section that points readers to custom columns as the right starting point for prototyping column-generator behavior or for one-off project-specific columns. It also says to promote that logic to a column generator plugin once it needs a stable config schema, tests, packaging, docs, or reuse across teams. |
6c9a3ce to
995a725
Compare
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
efda041 to
8ecacb8
Compare
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