Skip to content

Commit 6cdd909

Browse files
justaddcoffeeclaude
andcommitted
Add explicit save location for D4D Assistant datasheets
Create data/sheets_d4d_agent/ directory as the designated location for all D4D datasheets created by the GitHub Actions assistant. Changes: - Create data/sheets_d4d_agent/ directory with README - Update d4d_assistant_create.md to use explicit save location - Replace "suggested locations" with required OUTPUT_FILE path - Clarify separation between assistant outputs, examples, and extractions This makes it clear where the assistant should save files rather than leaving it ambiguous with multiple suggestions. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 9c1b6e8 commit 6cdd909

File tree

2 files changed

+53
-6
lines changed

2 files changed

+53
-6
lines changed

.github/workflows/d4d_assistant_create.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -167,16 +167,22 @@ collection_process:
167167

168168
### 5. Save and Validate
169169

170-
**Determine Save Location:**
170+
**Save Location:**
171+
172+
All D4D datasheets created by the assistant MUST be saved to:
171173
```bash
172-
# Suggested locations:
173-
# - src/data/examples/valid/<dataset_name>_d4d.yaml (for example datasets)
174-
# - data/extracted_by_column/<project>/<dataset_name>_d4d.yaml (for project datasets)
174+
# Extract dataset name from YAML (use lowercase, replace spaces with underscores)
175+
DATASET_NAME="<dataset_name>" # e.g., "cm4ai", "ai_readi_voice"
175176

176-
# Use project-specific directory if dataset belongs to a known project (AI_READI, CHORUS, CM4AI, VOICE)
177-
OUTPUT_FILE="data/extracted_by_column/<project>/<dataset_name>_d4d.yaml"
177+
# Save location (REQUIRED - all assistant-created D4Ds go here)
178+
OUTPUT_FILE="data/sheets_d4d_agent/${DATASET_NAME}_d4d.yaml"
178179
```
179180

181+
**Why this location:**
182+
- Separates assistant-created datasheets from manually curated examples
183+
- All assistant outputs in one place for easy review and management
184+
- Distinct from project-specific extraction outputs in `data/extracted_by_column/`
185+
180186
**Validate Against Schema:**
181187

182188
**Critical**: Validation MUST pass before creating a PR. Do not skip this step.

data/sheets_d4d_agent/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# D4D Assistant Generated Datasheets
2+
3+
This directory contains D4D (Datasheets for Datasets) YAML files created by the D4D Assistant via GitHub Actions.
4+
5+
## Purpose
6+
7+
- **Automated Extraction**: Datasheets generated from documentation URLs by the D4D Assistant
8+
- **Review Staging**: All assistant-created datasheets saved here for human review before promotion
9+
- **Separation of Concerns**: Keeps automated outputs separate from:
10+
- Manually curated examples (`src/data/examples/valid/`)
11+
- Project-specific extractions (`data/extracted_by_column/`)
12+
13+
## File Naming Convention
14+
15+
Files follow the pattern: `<dataset_name>_d4d.yaml`
16+
17+
Where `<dataset_name>` is:
18+
- Lowercase
19+
- Spaces replaced with underscores
20+
- Derived from the dataset's official name or identifier
21+
22+
Examples:
23+
- `cm4ai_d4d.yaml`
24+
- `ai_readi_voice_d4d.yaml`
25+
- `chorus_dataset_d4d.yaml`
26+
27+
## Workflow
28+
29+
1. **Creation**: D4D Assistant extracts metadata from documentation URLs
30+
2. **Validation**: YAML validated against D4D schema before PR creation
31+
3. **Review**: Human reviewers check accuracy and completeness
32+
4. **Promotion**: After approval, files may be:
33+
- Moved to `src/data/examples/valid/` (if suitable as example)
34+
- Kept here as project documentation
35+
- Integrated into project-specific directories
36+
37+
## Related Documentation
38+
39+
- `.github/workflows/d4d_assistant_create.md` - Instructions for D4D Assistant
40+
- `CLAUDE.md` - Project instructions and D4D guidance
41+
- `src/data_sheets_schema/schema/data_sheets_schema_all.yaml` - Full D4D schema

0 commit comments

Comments
 (0)