-
-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathGettingStarted
More file actions
115 lines (69 loc) · 2.82 KB
/
Copy pathGettingStarted
File metadata and controls
115 lines (69 loc) · 2.82 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# Oqtane AI Playbook
## Setup and Integration Guide
This guide explains how to integrate the **Oqtane AI Playbook** into your existing Oqtane development environment so that AI tools such as GitHub Copilot can follow the Playbook governance rules when generating code.
---
# 1. Clone the Oqtane AI Playbook
Clone the **Oqtane AI Playbook** repository into the same root development directory where your Oqtane modules are located.
Example development structure before cloning:
```
\Source
├─ Oqtane.Framework
├─ MyCompany.Module.MyModule1
├─ MyCompany.Module.MyModule2
└─ MyCompany.Module.MyModule3
```
After cloning the Playbook:
```
\Source
├─ Oqtane.Framework
├─ oqtane-ai-playbook
├─ MyCompany.Module.MyModule1
├─ MyCompany.Module.MyModule2
└─ MyCompany.Module.MyModule3
```
The Playbook should sit **alongside your modules**, not inside them.
---
# 2. Prepare Your Solution
To enable AI tooling integration, your Visual Studio solution must be saved as a **`.slnx` solution file**.
If your solution is currently `.sln`, save a copy as:
YourSolution.slnx
The `.slnx` format allows AI tooling to better discover workspace resources.
---
# 3. Add the Playbook Starter Script
Copy the starter script from the Playbook example project:
`
.\oqtane-ai-playbook\module-playbook-example\Start-Solution.cmd
`
Place this file in the **root of your development folder**:
`\Source\Oqtane\Start-Solution.cmd`
---
# 4. Launch the Playbook Enabled Solution
Double click:
Start-Solution.cmd
This script will:
- Open the Visual Studio solution
- Register the Playbook example resources
- Expose governance rules to AI tools
- Ensure Copilot can discover the Playbook guidance
The **module-playbook-example** project acts as a **reference implementation** and demonstrates how Playbook governed modules should be structured.
Note that this example project may evolve over time as the Playbook grows.
---
# 5. Verify Copilot Recognizes the Playbook
After Visual Studio loads, confirm that GitHub Copilot can see the Playbook rules.
In Copilot Chat, run the following prompt:
What governance rules from the Oqtane AI Playbook are available in this workspace?
Copilot should reference Playbook rules such as:
- Runtime Awareness
- Migrations
- Packaging and Dependencies
- UI Governance
- Scheduled Jobs and Site Tasks
If these rules appear in the response, the Playbook has been successfully integrated.
---
# 6. Next Steps
Once the Playbook is active, you can begin prompting AI using Playbook aware instructions such as:
Create a new Oqtane module following the Oqtane AI Playbook governance rules.
or
Implement a migration following rule **027x-migrations.md**
This ensures generated code follows **deterministic architecture patterns** defined by the Playbook.