Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 29, 2026

Schema architecture was simplified from 3 files to 2 when included_file_schema.json was consolidated into main_workflow_schema.json. Code was updated but one documentation reference still mentioned "three schemas".

Changes

  • specs/schema-validation.md: Updated "three schemas" → "two schemas" in "Adding New Fields" section

Current architecture

pkg/parser/schemas/
├── main_workflow_schema.json  # Handles both main and included workflows
└── mcp_config_schema.json     # MCP tool configurations

Other documentation files (skills/developer/SKILL.md, .github/workflows/schema-consistency-checker.md) already reflected the 2-schema structure correctly.

Original prompt

This section details on the original issue you should resolve

<issue_title>[Code Quality] Remove included_file_schema references from documentation</issue_title>
<issue_description>The included_file_schema.json file was removed from the codebase as part of a schema consolidation, but documentation still references it in multiple places, causing developer confusion about the current schema architecture.

Source

Extracted from Schema Consistency Analysis discussion githubnext/gh-aw#11121

Problem

Schema Architecture Changed:

  • Previous: 3 schemas (main_workflow_schema.json, included_file_schema.json, mcp_config_schema.json)
  • Current: 2 schemas (main_workflow_schema.json for both main and included workflows, mcp_config_schema.json)

Status:

  • Code: All parser and compiler code successfully updated (no references remain)
  • Documentation: Still references old 3-schema architecture

Files Requiring Updates

  1. specs/schema-validation.md:15, 91 - Remove included_file_schema references
  2. skills/developer/SKILL.md:1094 - Update schema files table to show 2 schemas
  3. .github/workflows/schema-consistency-checker.md:85 - Remove from key files list
  4. .github/workflows/schema-consistency-checker.lock.yml:690 - Update workflow instructions

Current Architecture (Correct)

pkg/parser/schemas/
├── main_workflow_schema.json        # Used for BOTH main AND included workflows
└── mcp_config_schema.json           # Used for MCP tool configurations

Success Criteria

  • All 4 files updated to reflect current 2-schema architecture
  • No remaining references to included_file_schema.json
  • Documentation accurately describes current schema structure
  • Schema architecture section in developer docs is correct

Priority

High - Documentation mismatch causes developer confusion and wastes time. The code migration was completed cleanly; documentation needs to catch up.

Estimated Effort

2-3 hours - Need to review each file, update references, verify accuracy, and test documentation builds.

AI generated by Discussion Task Miner - Code Quality Improvement Agent

  • expires on Feb 12, 2026, 1:34 AM UTC

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits January 29, 2026 03:06
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Remove included_file_schema references from documentation Docs: Update schema count after included_file_schema consolidation Jan 29, 2026
Copilot AI requested a review from pelikhan January 29, 2026 03:10
@pelikhan pelikhan marked this pull request as ready for review January 29, 2026 03:11
@pelikhan pelikhan merged commit d6d8d13 into main Jan 29, 2026
@pelikhan pelikhan deleted the copilot/remove-included-file-schema-references branch January 29, 2026 03:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Code Quality] Remove included_file_schema references from documentation

2 participants