-
Notifications
You must be signed in to change notification settings - Fork 9
feat(docs): add RPI workflow documentation and restructure docs folder #102
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…ed guides - add docs/rpi/ with overview, task-researcher, task-planner, task-implementor, using-together guides - restructure docs/getting-started/ with setup README and first-workflow tutorial - add docs/contributing/README.md as folder index - optimize root README with What's Included table and Documentation section - add optional scripts guidance to getting-started README 📚 - Generated by Copilot
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR introduces comprehensive RPI (Research → Plan → Implement) workflow documentation and restructures the docs folder for improved discoverability and learning paths. The changes establish the RPI workflow as the primary methodology for complex development tasks using GitHub Copilot chat modes, providing clear tutorials and guides for new users.
Key changes:
- Creates five new RPI workflow articles documenting the research, planning, and implementation phases with complete walkthrough examples
- Adds a hands-on 15-minute tutorial guide for first-time users to experience the RPI workflow
- Restructures documentation into logical folders (
getting-started/,rpi/,contributing/) with consolidated contributing guides - Updates root README to highlight the RPI workflow and streamline feature presentation
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/rpi/README.md | RPI framework overview explaining the three-phase workflow |
| docs/rpi/using-together.md | Complete walkthrough with Azure Blob Storage integration example |
| docs/rpi/task-researcher.md | Guide for using Task Researcher chat mode for research phase |
| docs/rpi/task-planner.md | Guide for using Task Planner chat mode for planning phase |
| docs/rpi/task-implementor.md | Guide for using Task Implementor chat mode for implementation |
| docs/getting-started/first-workflow.md | Hands-on tutorial creating PowerShell validation script |
| docs/getting-started/README.md | Updated with optional scripts section and corrected navigation links |
| docs/contributing/README.md | New landing page consolidating contribution guides |
| docs/contributing/prompts.md | Fixed relative link paths to use correct directory structure |
| docs/contributing/instructions.md | Fixed relative link paths to use correct directory structure |
| docs/contributing/chatmodes.md | Fixed relative link paths to use correct directory structure |
| docs/contributing/ai-artifacts-common.md | Fixed relative link paths with one incorrect path remaining |
| README.md | Streamlined to highlight RPI workflow with condensed feature table |
| .github/chatmodes/README.md | Updated getting started link to reflect new docs structure |
Comments suppressed due to low confidence (1)
docs/contributing/ai-artifacts-common.md:470
- Incorrect relative path. From
docs/contributing/ai-artifacts-common.md, the path to.github/PULL_REQUEST_TEMPLATE.mdshould use two parent directory references, not three.
Change from:
* [Pull Request Template](../../../.github/PULL_REQUEST_TEMPLATE.md) - Submission checklistTo:
* [Pull Request Template](../../.github/PULL_REQUEST_TEMPLATE.md) - Submission checklistThe corrected path: docs/contributing/ → ../ → docs/ → ../ → root → .github/PULL_REQUEST_TEMPLATE.md
…ssues - Fix inconsistent list format in using-together.md - Add missing conjunction in first-workflow.md - Fix typo: conceptual -> concept in rpi/README.md - Expand ms.topic enum values in frontmatter schemas - Fix schema mapping to correctly scope root patterns to repo root Closes #103
- Fix table column alignment in .github/chatmodes/README.md - Fix table column alignment in .github/instructions/README.md - Add author, ms.date, ms.topic to docs/contributing/*.md 📝 - Generated by Copilot
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 19 out of 19 changed files in this pull request and generated 2 comments.
Comments suppressed due to low confidence (5)
scripts/linting/Validate-MarkdownFrontmatter.ps1:298
- Duplicate
elseifblock at lines 284-294 and 295-298 handling the same condition. The first block (284-294) performs regex conversion but is unreachable dead code because the second block (295-298) will always match first when the condition is true. Remove lines 295-298 to eliminate the duplicate logic, or if the simpler version at 295-298 is intended, remove the complex regex version at 284-294.
# Simple file patterns
elseif ($relativePath -like $rule.pattern -or $fileName -like $rule.pattern) {
# Convert glob to regex: '**/' => '(.*/)?', '*' => '[^/]*', '.' => '\.'
$regexPattern = $rule.pattern
$regexPattern = $regexPattern -replace '\*\*/', '(.*/)?'
$regexPattern = $regexPattern -replace '\*', '[^/]*'
$regexPattern = $regexPattern -replace '\.', '\.'
$regexPattern = '^' + $regexPattern + '$'
if ($relativePath -match $regexPattern) {
return Join-Path -Path $schemaDir -ChildPath $rule.schema
}
}
# Simple file patterns
elseif ($relativePath -like $rule.pattern -or $fileName -like $rule.pattern) {
return Join-Path -Path $schemaDir -ChildPath $rule.schema
}
docs/contributing/prompts.md:5
- The date 2025-11-26 is in the future (current date is November 2025). The ms.date field should reflect the actual last modified date, not a future placeholder date. Ensure consistency with actual modification dates across all documentation.
docs/contributing/instructions.md:5 - The date 2025-11-26 is in the future (current date is November 2025). The ms.date field should reflect the actual last modified date, not a future placeholder. Use the date when this file was actually modified.
docs/contributing/chatmodes.md:5 - The date 2025-11-26 is in the future (current date is November 2025). The ms.date field should reflect the actual last modified date, not a future placeholder. Correct this to match when the file was actually updated.
docs/contributing/ai-artifacts-common.md:5 - The date 2025-11-26 is in the future (current date is November 2025). The ms.date field should reflect the actual last modified date. Use the actual modification date instead of a future placeholder.
Summary
Adds comprehensive RPI (Research → Plan → Implement) workflow documentation and restructures the docs folder for better discoverability.
Changes
New Documentation Structure
docs/getting-started/- Setup guide and first workflow tutorialdocs/rpi/- Five RPI workflow articles (overview, researcher, planner, implementor, using-together)docs/contributing/- Consolidated contributing guidesRPI Workflow Articles
README.mdtask-researcher.mdtask-planner.mdtask-implementor.mdusing-together.mdGetting Started Updates
first-workflow.md- Hands-on 15-minute RPI tutorial using PowerShell script creationREADME.md- Added optional scripts section for users to copy to their projectsRoot README Optimization
Linting Fixes
ms.topicenum values in frontmatter schemas (guide,hub-page,architecture,research)conceptual→conceptindocs/rpi/README.mdTesting
markdownlint-cli2validationcspellspelling checknpm run format:tablesCloses
Closes #101
Closes #103
Related Work
Establishes the primary learning path for new HVE Core users.