docs: consolidated seed reader documentation#481
Conversation
… rollout sources Add comprehensive documentation for DirectorySeedSource, FileContentsSeedSource, and AgentRolloutSeedSource to the seed datasets concept page. Add FileSystemSeedReader plugin authoring guide and Markdown section seed reader recipe. Supersedes #425 and #452. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Greptile SummaryThis is a documentation-only PR that consolidates seed reader documentation for filesystem and agent rollout sources, adds a new Key changes:
|
| Filename | Overview |
|---|---|
| docs/concepts/seed-datasets.md | Adds DirectorySeedSource, FileContentsSeedSource, and AgentRolloutSeedSource sections with column listings and code examples; also fixes the designer.preview() → data_designer.preview() bug in the Complete Example. |
| docs/plugins/filesystem_seed_reader.md | New guide covering the FileSystemSeedReader plugin contract (build_manifest/hydrate_row), inline reader pattern, manifest-based selection semantics, and packaging step; accurate against the engine implementation. |
| docs/assets/recipes/plugin_development/markdown_seed_reader.py | New self-contained runnable recipe demonstrating a 1:N FileSystemSeedReader with ATX-heading-based Markdown section fanout; logic is correct and output_columns match the hydrated record schema exactly. |
| docs/recipes/plugin_development/markdown_seed_reader.md | New recipe landing page with correct relative paths for the download button, the --8<-- snippet include, and the cross-link back to the plugin guide. |
| mkdocs.yml | Adds the Plugin Development recipe section and the FileSystemSeedReader Plugins page to the nav; paths are correct and ordered consistently. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User calls DataDesigner.preview / create] --> B{Seed source type?}
B -->|LocalFile / HuggingFace / DataFrame| C[Built-in SeedReader]
B -->|DirectorySeedSource / FileContentsSeedSource| D[FileSystemSeedReader]
B -->|AgentRolloutSeedSource| E[AgentRolloutSeedReader]
B -->|DirectorySeedSource + custom reader| F[Custom FileSystemSeedReader\ne.g. MarkdownSectionDirectorySeedReader]
D --> G[build_manifest\nenumerate matching files]
F --> G
G --> H[IndexRange / PartitionBlock / shuffle\noperates on manifest rows]
H --> I[hydrate_row per manifest row\n1:1 or 1:N fanout]
I --> J[output_columns schema validation]
J --> K[DuckDB registration\n→ seed columns available in Jinja2 templates]
E --> K
C --> K
Reviews (1): Last reviewed commit: "docs: consolidated seed reader documenta..." | Re-trigger Greptile
Summary
DirectorySeedSource,FileContentsSeedSource, andAgentRolloutSeedSourcesections to the seed datasets concept page with code examples, exposed column lists, and cross-linksFileSystemSeedReaderplugin authoring guide (docs/plugins/filesystem_seed_reader.md) covering the manifest/hydration contract, inline reader pattern, selection semantics, and packaging guidance1:Nfilesystem reader example)FileSystemSeedReaderand the new guidedesigner.preview()→data_designer.preview()bug in the complete exampleSupersedes #425 and #452.