Skip to content

Commit e385903

Browse files
committed
fix: move AI tool config files back to .github/ directory
Reverts part of previous commit - copilot-tasks.md and custom-instructions.md are AI tool configuration files, not user-facing documentation. Changes: - Move docs/COPILOT_TASKS.md back to .github/copilot-tasks.md - Move docs/CUSTOM_INSTRUCTIONS.md back to .github/custom-instructions.md - Update .github/README.md to list these files as root-level config - Update docs/FILE_ORGANIZATION.md to clarify distinction between: * .github/ = Infrastructure and AI tool configuration * docs/ = User-facing documentation for developers and contributors Clarification: Only permanent user-facing documentation belongs in docs/. AI tool configurations belong in .github/ with other infrastructure.
1 parent 40a5342 commit e385903

File tree

6 files changed

+20
-13
lines changed

6 files changed

+20
-13
lines changed

.github/README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,12 @@ This directory contains GitHub-specific configuration files for the {{theme_name
2020
- **reports/** - Completed task reports and validation outcomes
2121
- **schemas/** - JSON schemas and configuration templates
2222
- **workflows/** - GitHub Actions CI/CD workflow definitions
23+
- `copilot-tasks.md` - Copilot task definitions and specifications
24+
- `custom-instructions.md` - Custom AI instructions for Copilot
2325

2426
## Documentation
2527

26-
Permanent documentation is stored in the [docs/](../docs/) folder, not here. See:
27-
28-
- [docs/FILE_ORGANIZATION.md](../docs/FILE_ORGANIZATION.md) - File organization guide
29-
- [docs/COPILOT_TASKS.md](../docs/COPILOT_TASKS.md) - Copilot task definitions
30-
- [docs/CUSTOM_INSTRUCTIONS.md](../docs/CUSTOM_INSTRUCTIONS.md) - Custom AI instructions
28+
Permanent user-facing documentation is stored in the [docs/](../docs/) folder. See [docs/FILE_ORGANIZATION.md](../docs/FILE_ORGANIZATION.md) for the complete file organization guide.
3129

3230
## Workflows
3331

File renamed without changes.
File renamed without changes.

.github/projects/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Projects use status indicators to show current progress:
2424
**Purpose:** Comprehensive plan to reduce token bloat and context usage in the block-theme-scaffold repository.
2525

2626
**Phases:**
27+
2728
- ✅ Phase 1: Delete Model-Specific Files (~495 lines removed)
2829
- ✅ Phase 2: Consolidate Documentation (merged governance and development docs)
2930
- ✅ Phase 3: Optimize Core Index Files (reduced AGENTS.md, agent.md, prompts.md)
@@ -45,6 +46,7 @@ Projects use status indicators to show current progress:
4546
- Example: `context-reduction.md`
4647

4748
2. Include project header:
49+
4850
```markdown
4951
# Project Title
5052

.github/schemas/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@ This directory contains JSON schemas and configuration templates used for code g
99
**Purpose:** Official JSON Schema defining all valid configuration options for theme generation.
1010

1111
**Usage:**
12+
1213
- Defines the structure and validation rules for theme configuration files
1314
- Used by theme generators to validate user input
1415
- Referenced by editors and IDEs for autocomplete and validation
1516
- Provides documentation for all available configuration options
1617

1718
**Schema Defines:**
19+
1820
- Required fields (theme_slug, theme_name, author)
1921
- Optional fields (description, version, license, etc.)
2022
- Design system tokens (colors, typography, spacing)
@@ -23,6 +25,7 @@ This directory contains JSON schemas and configuration templates used for code g
2325
- Content options
2426

2527
**Example:**
28+
2629
```bash
2730
# Validate a configuration file against the schema
2831
jq -f .github/schemas/theme-config.schema.json my-config.json
@@ -33,18 +36,21 @@ jq -f .github/schemas/theme-config.schema.json my-config.json
3336
**Purpose:** Pre-filled example configuration showing realistic values for all schema fields.
3437

3538
**Usage:**
39+
3640
- Template for users creating new theme configurations
3741
- Reference implementation of all available options
3842
- Documentation through working example
3943
- Copy and customize for new projects
4044

4145
**Content:**
46+
4247
- Complete theme-config with all sections populated
4348
- Realistic values for Tour Operator theme
4449
- Comments explaining each major section
4550
- Valid against theme-config.schema.json
4651

4752
**Example:**
53+
4854
```bash
4955
# Copy example to create your own configuration
5056
cp .github/schemas/theme-config.example.json my-theme-config.json

docs/FILE_ORGANIZATION.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,17 @@ This document explains where different types of files are stored in the block-th
1313

1414
## Core Policy: Documentation Location
1515

16-
**🔑 Key Rule:** All permanent documentation must be stored in the `docs/` folder, not in `.github/` subdirectories.
16+
**🔑 Key Rule:** All permanent user-facing documentation must be stored in the `docs/` folder, not in `.github/` subdirectories.
1717

18-
- `.github/` is for infrastructure, configuration, and transient work (projects, reports)
19-
- `docs/` is for permanent, versioned documentation
18+
- `.github/` is for infrastructure, AI tool configuration, and transient work (projects, reports)
19+
- `docs/` is for permanent documentation that developers and contributors read regularly
2020
- `tmp/` and `logs/` do NOT include README.md files
2121

2222
This separation ensures:
2323

24-
- Clear distinction between infrastructure and documentation
24+
- Clear distinction between infrastructure/tooling and user documentation
2525
- Permanent docs are discoverable and grouped together
26+
- AI tool configuration stays with GitHub infrastructure
2627
- Easier navigation for developers and AI agents
2728
- Reduces cognitive overhead
2829

@@ -37,14 +38,14 @@ block-theme-scaffold/
3738
│ ├── instructions/ # AI agent & coding standards
3839
│ ├── agents/ # Agent specifications and code
3940
│ ├── workflows/ # GitHub Actions CI/CD
40-
│ └── prompts/ # Prompt templates for AI generation
41-
├── docs/ # ⭐ ALL permanent documentation here
41+
│ ├── prompts/ # Prompt templates for AI generation
42+
│ ├── copilot-tasks.md # Copilot task definitions
43+
│ └── custom-instructions.md # Custom AI instructions
44+
├── docs/ # ⭐ ALL permanent user-facing documentation here
4245
│ ├── GOVERNANCE-START-HERE.md # Navigation hub
4346
│ ├── GOVERNANCE.md # Core policies & standards
4447
│ ├── ARCHITECTURE.md # Project structure
4548
│ ├── FILE_ORGANIZATION.md # This file
46-
│ ├── CUSTOM_INSTRUCTIONS.md # Custom AI instructions
47-
│ ├── COPILOT_TASKS.md # Copilot task definitions
4849
│ └── [other comprehensive guides]/
4950
├── src/ # Source code (JS, CSS)
5051
├── inc/ # PHP includes

0 commit comments

Comments
 (0)