chore: plan 427, PR 2 of agent-first development plan#478
Conversation
Greptile SummaryThis PR populates all 10 The one minor omission worth noting:
|
| Filename | Overview |
|---|---|
| architecture/overview.md | Accurately describes three-package layout, PEP 420 namespace packages, data flow, and dual execution engines; cross-references verified |
| architecture/config.md | Accurately covers builder API, discriminated unions, model configs, and lazy imports; consistent with source structure |
| architecture/engine.md | Correctly documents compilation pipeline, registry system, column generator hierarchy, and ResourceProvider |
| architecture/models.md | AIMD throttling, strip_rate_limit_codes sync/async behavior, and facade pattern verified against source; accurate |
| architecture/mcp.md | _MCP_IO_SERVICE singleton, atexit registration, session pooling, and tool coalescing verified against io.py; accurate |
| architecture/dataset-builders.md | AsyncTaskScheduler and RowGroupBufferManager class names verified; sequential and async execution paths accurately described |
| architecture/sampling.md | Accurately describes DatasetGenerator, constraint system, PeopleGen/PeopleGenFaker hierarchy, and managed datasets |
| architecture/cli.md | Correctly documents lazy command loading, controller/service/repo pattern, and generation command delegation |
| architecture/agent-introspection.md | FamilySpec, type discovery, state commands, and AGENT_COMMANDS single-source registration accurately documented |
| architecture/plugins.md | Entry-point discovery, PluginRegistry singleton, union injection, and custom column comparison table accurately described |
| .github/PULL_REQUEST_TEMPLATE.md | New PR template with Summary, Related Issue, Changes, Testing, and Checklist sections; well-structured |
| .github/ISSUE_TEMPLATE/bug-report.yml | Adds optional Agent Diagnostic field and investigation checklist; required/optional designations are appropriate |
| .github/ISSUE_TEMPLATE/feature-request.yml | Adds optional Agent Investigation field; existing required fields preserved correctly |
| .github/ISSUE_TEMPLATE/development-task.yml | Adds Investigation/Context and Agent Plan optional fields; consistent with other template additions |
| .github/ISSUE_TEMPLATE/config.yml | Updates Discussions link copy to mention agent-assisted workflow |
| .agents/skills/create-pr/SKILL.md | Updated to produce PR descriptions matching new template structure; steps consistent with PULL_REQUEST_TEMPLATE.md |
| .agents/skills/review-code/SKILL.md | Updated documentation sources to reference newly populated architecture/*.md files; change not described in PR Changes section |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[PR 1: Architecture stubs created] --> B[PR 2: This PR]
B --> C[Architecture docs populated ×10]
B --> D[GitHub Templates updated]
B --> E[create-pr SKILL updated]
B --> F[review-code SKILL updated]
C --> C1[overview.md]
C --> C2[config.md]
C --> C3[engine.md]
C --> C4[models.md]
C --> C5[mcp.md]
C --> C6[dataset-builders.md]
C --> C7[sampling.md]
C --> C8[cli.md]
C --> C9[agent-introspection.md]
C --> C10[plugins.md]
D --> D1[PULL_REQUEST_TEMPLATE.md]
D --> D2[bug-report.yml]
D --> D3[feature-request.yml]
D --> D4[development-task.yml]
D --> D5[config.yml]
Reviews (7): Last reviewed commit: "Merge branch 'main' into nmulepati/docs/..." | Re-trigger Greptile
Co-authored-by: Johnny Greco <jogreco@nvidia.com>
|
good candidate for the Monday docs-and-references suite from #472 - symbol-level checks would catch this kind of drift automatically going forward. |
Address review comments: - models.md: describe clients as native httpx adapters, not SDK wrappers - agent-introspection.md: use actual family keys (columns, samplers, etc.) not column-types - cli.md: use correct command `data-designer config models` - plugins.md: SEED_READER not SEED_SOURCE, inject_into_processor_config_type_union Made-with: Cursor
📋 Summary
Implements PR 2 of the agent-first development plan (#427), covering Phase 3 (GitHub machinery) and architecture doc population. PR 1 (#454) restructured the top-level documentation and created the architecture stubs; this PR fills them with content and adds the GitHub templates that make the agent-assisted contribution workflow concrete.
🔗 Related Issue
PR-2 for #427
🔄 Changes
Architecture Documentation (10 files populated)
All
architecture/stubs from PR 1 are now populated with content covering overview, key components, data flow, design decisions, and cross-references:overview.md— System architecture: three-package layout, PEP 420 namespace packages, end-to-end data flow, dual execution enginesconfig.md— Config layer: builder API, column configs, discriminated unions, model configs, plugin injection, lazy importsengine.md— Engine layer: compilation pipeline, registry system, column generator hierarchy, ResourceProvidermodels.md— Model subsystem: facade pattern, AIMD throttling, retry transport, usage tracking, MCP tool loopsmcp.md— MCP subsystem: MCPIOService, session pooling, tool schema coalescing, turn limitsdataset-builders.md— Dataset builders: sequential/async execution, ExecutionGraph, CompletionTracker, DAG, DatasetBatchManagersampling.md— Sampling: DatasetGenerator, constraint system, person/entity generation, managed datasetscli.md— CLI: lazy command loading, controller/service/repo pattern, generation commandsagent-introspection.md— Agent introspection: FamilySpec, type discovery, state commands, error handlingplugins.md— Plugin system: entry-point discovery, PluginRegistry, union injection, custom columns comparisonGitHub Templates (Phase 3)
.github/PULL_REQUEST_TEMPLATE.md— New PR template: Summary, Related Issue, Changes, Testing checklist, Checklist.github/ISSUE_TEMPLATE/bug-report.yml— Added Agent Diagnostic field and investigation checklist.github/ISSUE_TEMPLATE/feature-request.yml— Added Agent Investigation field and review checklist.github/ISSUE_TEMPLATE/development-task.yml— Added Investigation/Context and Agent Plan fields.github/ISSUE_TEMPLATE/config.yml— Updated Discussions link copy to mention agent-assisted workflowSkill Template Conformance
.agents/skills/create-pr/SKILL.md— Updated to produce PR descriptions matching the new PR template structure (Summary, Related Issue, Changes, Testing, Checklist)Not Yet Addressed (from plan step list)
gh label createafter merge, or in a follow-up🔍 Attention Areas
dataset-builders.md(async engine) andmodels.md(AIMD throttling).🧪 Testing
✅ Checklist