Skip to content

Commit 63f64a5

Browse files
aboseabose
committed
refined docs
1 parent 876497a commit 63f64a5

File tree

1 file changed

+25
-62
lines changed

1 file changed

+25
-62
lines changed

‎docs/02-control-ai.md‎

Lines changed: 25 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Download the appropriate script for your platform from [this link](https://githu
6060
```
6161

6262
:::note
63-
The `--managedByEmail` parameter is optional but recommended. It provides an administrative contact for managing access to AI and educational features in the future. This email will be linked to your institution’s AI management if given.
63+
The `--managedByEmail` parameter is optional but recommended. It provides an administrative contact for managing access to AI and educational features in the future. This email will be linked to your institution's AI management if given.
6464
:::
6565

6666
</TabItem>
@@ -133,16 +133,6 @@ Always enclose the `--allowedUsers` list in quotes to prevent parsing errors (e.
133133

134134
## Common Configuration Examples
135135

136-
<Tabs
137-
defaultValue="disable"
138-
values={[
139-
{ label: 'Disable AI', value: 'disable' },
140-
{ label: 'Enable AI', value: 'enable' },
141-
{ label: 'Selective Access', value: 'selective' },
142-
]}>
143-
144-
<TabItem value="disable">
145-
146136
### Disabling AI for All Users
147137

148138
To disable AI features system-wide:
@@ -180,10 +170,6 @@ sudo ./setup_phoenix_ai_control_linux.sh --disableAI --managedByEmail school.adm
180170
</TabItem>
181171
</Tabs>
182172

183-
</TabItem>
184-
185-
<TabItem value="enable">
186-
187173
### Enabling AI for All Users
188174

189175
To enable AI features system-wide:
@@ -221,10 +207,6 @@ sudo ./setup_phoenix_ai_control_linux.sh --managedByEmail [email protected]
221207
</TabItem>
222208
</Tabs>
223209

224-
</TabItem>
225-
226-
<TabItem value="selective">
227-
228210
### Enabling AI for Specific Users Only
229211

230212
To disable AI globally but allow specific users to access it:
@@ -266,9 +248,6 @@ sudo ./setup_phoenix_ai_control_linux.sh --disableAI --allowedUsers "teacher1,ad
266248
Always enclose the list of users in quotes to prevent parsing errors
267249
:::
268250

269-
</TabItem>
270-
</Tabs>
271-
272251
## Verifying AI Control Status
273252

274253
The Phoenix Code AI Control extension provides a visual interface to verify the current status of AI controls on end-user machines.
@@ -350,38 +329,31 @@ The browser version of Phoenix Code will automatically detect if the domain is u
350329

351330
## FAQ
352331

353-
<details>
354-
<summary>When will AI be enabled in Phoenix Code?</summary>
332+
**Q: When will AI be enabled in Phoenix Code?**
333+
355334
Phoenix Code AI will be rolled out after May 20, 2025. Educational institutions should configure AI controls campus-wide before this date.
356-
</details>
357335

358-
<details>
359-
<summary>How do I know if AI control is working?</summary>
336+
**Q: How do I know if AI control is working?**
337+
360338
In both the desktop and browser versions, go to View → AI Control Status to see a detailed report.
361-
</details>
362339

363-
<details>
364-
<summary>Can I allow specific users to access AI features?</summary>
340+
**Q: Can I allow specific users to access AI features?**
341+
365342
Yes, but only in the desktop version. Use the `--allowedUsers` parameter with a comma-separated list of usernames when running the installation script. These users will be able to access AI features even when disabled system-wide with the `--disableAI` flag.
366-
</details>
367343

368-
<details>
369-
<summary>Is AI control mandatory?</summary>
344+
**Q: Is AI control mandatory?**
345+
370346
No, AI control is optional and meant for educational institutions or enterprises that need to regulate AI usage. By default, all users have access to AI features.
371-
</details>
372347

373-
<details>
374-
<summary>Will blocking AI affect other Phoenix Code features?</summary>
348+
**Q: Will blocking AI affect other Phoenix Code features?**
349+
375350
No, all other features of Phoenix Code will continue to work normally. Only the AI-powered features like code generation and explanations will be affected.
376-
</details>
377351

378-
<details>
379-
<summary>How can I update the AI control configuration?</summary>
352+
**Q: How can I update the AI control configuration?**
353+
380354
Simply run the installation script again with the new parameters. The script will overwrite the existing configuration file with your new settings.
381-
</details>
382355

383-
<details>
384-
<summary>How do I re-enable AI after it has been disabled?</summary>
356+
**Q: How do I re-enable AI after it has been disabled?**
385357

386358
To re-enable AI that was previously disabled:
387359

@@ -421,42 +393,33 @@ sudo ./setup_phoenix_ai_control_linux.sh --managedByEmail [email protected]
421393
</Tabs>
422394

423395
2. For browser version, remove any firewall rules blocking `ai.phcode.dev`
424-
</details>
425-
426-
<details>
427-
<summary>What's the difference between browser and desktop control?</summary>
428396

397+
**Q: What's the difference between browser and desktop control?**
429398
- **Browser Version**: Only supports network-level blocking of `ai.phcode.dev` through your firewall
430399
- **Desktop Version**: Provides comprehensive control through configuration files with user-specific permissions
431-
</details>
432-
433-
<details>
434-
<summary>Does this completely prevent AI usage?</summary>
435400

401+
**Q: Does this completely prevent AI usage?**
436402
- **Desktop Version**: Yes, the control is comprehensive when properly configured using the installation scripts
437403
- **Browser Version**: Only if you implement network-level blocking of the `ai.phcode.dev` domain
438-
</details>
439404

440-
<details>
441-
<summary>How can I verify that the firewall is properly blocking AI access?</summary>
405+
**Q: How can I verify that the firewall is properly blocking AI access?**
406+
442407
In the browser version, use the View → AI Control Status option which will attempt to connect to the AI service and report whether it's accessible or blocked.
443-
</details>
444408

445-
<details>
446-
<summary>Can I disable AI for some users but enable it for others?</summary>
409+
**Q: Can I disable AI for some users but enable it for others?**
410+
447411
Yes, use the `--disableAI` flag to disable AI globally, then use the `--allowedUsers` parameter to specify which users should still have access. Example:
448412

449413
```bash
450414
sudo ./setup_phoenix_ai_control_linux.sh --disableAI --allowedUsers "teacher1,admin2"
451415
```
452-
</details>
453416

454-
<details>
455-
<summary>Is there a way to monitor AI usage in my organization?</summary>
417+
**Q: Is there a way to monitor AI usage in my organization?**
418+
456419
When you set the `--managedByEmail` parameter, this information is used for administration purposes. Future versions will provide a dashboard for administrators to monitor and manage AI usage across their organization.
457-
</details>
420+
However, this is currently not implemented.
458421

459422
## Additional Resources
460423

461-
AI complete: if someone wants to reach out for any special cases or this script doesnt work for you
462-
or any other special request, we will be more than happy to assist you. please reach out using https://github.com/orgs/phcode-dev/discussions/new/choose
424+
For any special requests or technical issues, please reach out through our discussions forum at https://github.com/orgs/phcode-dev/discussions/new/choose.
425+
We're committed to supporting a smooth rollout of AI controls for educational or organizational needs.

0 commit comments

Comments
 (0)