You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
📝 docs: add copilot instructions and update config wizard readme
- Create `copilot-instructions.md` for Hugo site documentation.
- Update `CONFIG_WIZARD_README.md` with detailed design constraints and user/technical features.
- Improve documentation with structured content and detailed examples.
🔧 chore: restructure and clean documentation files
- Move `CONFIG_WIZARD_README.md` to `_site-docs` folder.
- Delete `class-options.html` shortcode file from partials directory.
- Create empty `copilot-instructions.md` and `.vscode/copilot-instructions.md` files.
- Processor selection is **locked** based on migration type
36
+
- Only processor-specific **options** are editable (e.g., WIQL queries, field mappings, performance settings)
37
+
- Simplified UI focuses on configuration rather than selection
38
+
39
+
#### **Custom Mode**
40
+
41
+
-**Full processor selection**: Choose from all available processors
42
+
-**Multiple processor support**: Add/remove processors as needed
43
+
-**Named endpoint association**: Each processor can reference named endpoints by name
44
+
-**Type validation**: Only compatible endpoints appear in dropdown for each processor
45
+
3
46
## Overview
4
47
5
48
This implementation provides a **comprehensive interactive configuration wizard** for the Azure DevOps Migration Tools. The wizard guides users through a step-by-step process to build their migration configuration without requiring deep knowledge of the underlying JSON structure.
@@ -17,22 +60,24 @@ This implementation provides a **comprehensive interactive configuration wizard*
# Copilot Instructions for `docs` (Hugo Site for Azure DevOps Migration Tools)
2
+
3
+
## Purpose
4
+
5
+
This `docs` folder contains the Hugo static site for Azure DevOps Migration Tools documentation. The site is deployed to Azure Static Web Apps and relies on YAML/Markdown data generated by `src/MigrationTools.ConsoleDataGenerator`.
6
+
7
+
## Features
8
+
9
+
### Config wizard
10
+
11
+
This site includes a configuration wizard that guides users through setting up their migration configurations interactively.
12
+
The wizard is designed to simplify the process of creating complex migration configurations by providing step-by-step instructions and examples.
13
+
Its documentation is in [config-wizard.md](_site-docs/CONFIG_WIZARD_README.md).
14
+
15
+
-**Key Features**:
16
+
- Interactive step-by-step configuration setup
17
+
- Example configurations for common scenarios
18
+
- Validation of user inputs against the schema
19
+
20
+
## Docs & Reference
21
+
22
+
The `docs\content\docs` directory contains the main documentation sections, including:
23
+
24
+
-**Getting Started**: Guides for new users to set up and use the migration tools.
25
+
-**How-To Guides**: Step-by-step tutorials for common tasks.
26
+
-**Reference Documentation**: Detailed information on configuration options, processors. Each page loads its data from YAML files in `docs/data/reference/`, and should be validated against the schema in `docs\static\schema`.
27
+
-**Setup Guides**: Instructions for installing and configuring the tools.
28
+
29
+
## Key Patterns & Requirements
30
+
31
+
### 1. Hugo Site Structure
32
+
33
+
- Use [Hugo](https://gohugo.io/) v0.146+ conventions for content, layouts, and data.
34
+
-**IMPORTANT**: This site uses Hugo's [new template system](https://gohugo.io/templates/new-templatesystem-overview/) (v0.146+) - ensure all template code follows the new patterns and syntax.
35
+
- Content lives in `content/`, layouts in `layouts/`, static assets in `static/`, and data in `data/`.
36
+
- All documentation pages should use Markdown with YAML front matter.
37
+
- Use shortcodes and partials for reusable content blocks.
38
+
- Follow the new template system's improved performance and syntax when creating layouts.
39
+
40
+
#### Folder Structure
41
+
42
+
```
43
+
docs/
44
+
├── _site-docs # Contains additional documentation about features in the site itself
45
+
├── content/ # Documentation content (Markdown with YAML front matter)
├── hugo.production.yaml # Production environment config
83
+
├── hugo.canary.yaml # Canary deployment config
84
+
└── .hugo_build.lock # Hugo build lock file
85
+
```
86
+
87
+
### 2. Data-Driven Documentation
88
+
89
+
- Reference YAML data files in `/docs/_data/` generated by `MigrationTools.ConsoleDataGenerator` for configuration samples, processor options, and reference docs.
90
+
- Do not manually edit files in `/docs/_data/`; always regenerate using the ConsoleDataGenerator after code changes.
91
+
- Use Hugo's `data` templates to render configuration samples and reference tables from YAML.
92
+
93
+
### 3. Documentation Generation Workflow
94
+
95
+
- When processor/option classes change, run the ConsoleDataGenerator to update YAML and Markdown docs.
96
+
- Validate that generated docs match the current codebase (see root copilot-instructions for checklist).
97
+
- Use the `GenerateDocs.ps1` script at the repo root for consistent doc generation.
98
+
99
+
### 4. Azure Static Web Apps Deployment
100
+
101
+
- The Hugo site is deployed to Azure Static Web Apps.
102
+
- Ensure all output is static and compatible with Azure SWA (no server-side code).
103
+
- Use the `staticwebapp.config.json` for SWA routing and configuration.
104
+
- Follow [Azure SWA best practices](https://learn.microsoft.com/azure/static-web-apps/) for performance and security.
105
+
106
+
### 5. Content & Style Guidelines
107
+
108
+
- Use clear, concise language and consistent formatting.
109
+
- Prefer code samples and configuration snippets sourced from generated YAML.
110
+
- Test all configuration samples against the schema documentation to ensure accuracy.
111
+
- Keep navigation and sidebar structure in sync with generated reference docs.
112
+
113
+
### 6. Maintenance
114
+
115
+
- Regenerate docs after any code or configuration option changes.
116
+
- Review generated Markdown and YAML for accuracy and completeness.
117
+
- Keep this instruction file up to date with any changes to the documentation workflow or deployment process.
0 commit comments