Skip to content

Commit df31011

Browse files
mintlify[bot]dustin-turskaMarfuen
authored
Remove Mintlify Doc ref (#1647)
* Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Dustin <dustin@trycomp.ai> Co-authored-by: Mariano Fuentes <marfuen98@gmail.com>
1 parent 176ddce commit df31011

File tree

6 files changed

+151
-86
lines changed

6 files changed

+151
-86
lines changed
85.3 KB
Loading
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: "Automated Evidence"
3+
description: "Comp AI Automated Evidence allows you to streamline evidence collection for recurring compliance tasks. "
4+
---
5+
6+
### Create Automations
7+
8+
To create automations for evidence collection, simply click into any task on the app, and click on the "Create Automation" button.
9+
10+
This will take you to the chat agent, here, you will enter a prompt based on the task and evidence required for that task.
11+
12+
### Example Prompt
13+
14+
In this example, we will use the project ‘Secure Code’ for this task. We need to show that Dependabot (or a similar tool) is enabled and scanning the dependencies in our codebase. For this prompt, we would say:\
15+
“Check if Dependabot is enabled in my GitHub repository and return the results.”
16+
17+
### Testing & Publishing Automations
18+
19+
Once prompted, the agent will run through the process of creating an automation to check for and return any Dependabot alerts, requesting any relevant keys or tokens required by that specific vendor to complete the automation.
20+
21+
Once the automation is complete, click ‘Test’. This will display the first output for that automation. If the output is sufficient, click ‘Publish’. This will publish the automation to the task, which will then run automatically—updating the evidence for that task according to the frequency set.
22+
23+
<Note>
24+
You can create multiple automations per task. Each piece of evidence will show in the "Automated Evidence" card on the task page.
25+
</Note>

packages/docs/device-agent.mdx

Lines changed: 100 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ If you have questions, contact your IT administrator.
2424
**Storage:** 200MB available disk space
2525

2626
<Note>
27-
For OS not currently support by the Comp AI device agent, manual evidence will be required of the device's settings.
27+
For OS not currently support by the Comp AI device agent, manual evidence will be required of the device's settings.
2828
</Note>
2929

3030
### Installation Guide
@@ -38,15 +38,25 @@ For Mac OS, users must enable MDM to complete the installation process:
3838
<Accordion title="MDM User Guide" description="Enable MDM" icon="computer">
3939
At the top of your screen, find the Fleet Desktop app which looks like an F made of dots. Click on it and click My Device:
4040

41-
![My Device Pn](/packages/docs/images/my-device.png)
41+
<img
42+
src="/packages/docs/images/my-device.png"
43+
alt="My Device Pn"
44+
className="mx-auto"
45+
style={{ width:"65%" }}
46+
/>
4247

4348
You should see a banner that asks you to enable MDM. Click the button:
4449

4550
![Enable Mdm Pn](/packages/docs/images/enable-mdm.png)
4651

4752
Click the Download button:
4853

49-
![Click Download Button Pn](/packages/docs/images/click-download-button.png)
54+
<img
55+
src="/packages/docs/images/click-download-button.png"
56+
alt="Click Download Button Pn"
57+
className="mx-auto"
58+
style={{ width:"66%" }}
59+
/>
5060

5161
Return to your Downloads folder and click on _fleet-mdm-enrollment-profile.mobileconfig:_
5262

@@ -59,19 +69,26 @@ For Mac OS, users must enable MDM to complete the installation process:
5969
alt="Click Ok Pn"
6070
title="Click Ok Pn"
6171
style={{ width:"55%" }}
72+
className="mx-auto"
6273
/>
6374

6475
Click the Apple icon in the upper left corner and go to System Settings:
6576

66-
![System Settings Icon Pn](/packages/docs/images/system-settings-icon.png)
77+
<img
78+
src="/packages/docs/images/system-settings-icon.png"
79+
alt="System Settings Icon Pn"
80+
className="mx-auto"
81+
style={{ width:"67%" }}
82+
/>
6783

6884
In System Settings, locate and click ‘Profile Downloaded’ in the left-hand column. Double-click on the Comp AI enrollment on the right:
6985

7086
<img
7187
src="/packages/docs/images/device-management.png"
7288
alt="Device Management Pn"
7389
title="Device Management Pn"
74-
style={{ width:"99%" }}
90+
style={{ width:"73%" }}
91+
className="mx-auto"
7592
/>
7693

7794
Click Install…:
@@ -81,6 +98,7 @@ For Mac OS, users must enable MDM to complete the installation process:
8198
alt="Install Comp Ai Pn"
8299
title="Install Comp Ai Pn"
83100
style={{ width:"56%" }}
101+
className="mx-auto"
84102
/>
85103

86104
Click Install:
@@ -90,6 +108,7 @@ For Mac OS, users must enable MDM to complete the installation process:
90108
alt="Final Install Pn"
91109
title="Final Install Pn"
92110
style={{ width:"56%" }}
111+
className="mx-auto"
93112
/>
94113

95114
Enter Credentials and click Enrol:
@@ -99,6 +118,7 @@ For Mac OS, users must enable MDM to complete the installation process:
99118
alt="Enrol Pn"
100119
title="Enrol Pn"
101120
style={{ width:"38%" }}
121+
className="mx-auto"
102122
/>
103123

104124
Enrollment is then complete:
@@ -108,39 +128,53 @@ For Mac OS, users must enable MDM to complete the installation process:
108128
alt="Enrollment Complete Pn"
109129
title="Enrollment Complete Pn"
110130
style={{ width:"60%" }}
131+
className="mx-auto"
111132
/>
112133
</Accordion>
113134

135+
### Manual Evidence collection
136+
137+
For users who do not wish to install the agent on their device, manual evidence of device settings is required. Below are the required pieces of evidence and where to obtain them.
138+
114139
<Accordion title="Windows Manual Evidence" description="Evidence to gather manually for unsupported windows devices" icon="sparkles">
115140
### **Windows 10 & 11**
116141

117-
1. **Enable BitLocker**
118-
1. Press **Start** → type **Manage BitLocker** → open it.\
119-
👉 **Take a screenshot of the BitLocker Drive Encryption window showing “On” for the C: drive.**
120-
2. Select the drive (usually C:) → click **Turn on BitLocker**.
121-
3. Save the recovery key to Microsoft Account / USB / secure location.
122-
4. Restart if prompted.
123-
2. **Screen Lock after 5 Minutes**
124-
1. Press **Start****Settings****Personalization****Lock screen**.
125-
2. Scroll down → click **Screen timeout settings**.\
126-
👉 **Take a screenshot showing the screen timeout set to 5 minutes.**
127-
3. Set **Screen turns off** = 5 minutes.
128-
4. In **Settings****Accounts****Sign-in options** → ensure **Require sign-in** is set to _“When PC wakes up from sleep”_.\
129-
👉 **Take a screenshot of the Sign-in Options page showing this setting**
130-
3. **Minimum Password Length (Local Policy)**
131-
1. Press Win + R, type secpol.msc, press Enter.
132-
2. Go to **Account Policies****Password Policy**.
133-
3. Set **Minimum password length** = 8+.\
134-
👉 **Take a screenshot of the Password Policy window with “Minimum password length” = 8 or more.**\
135-
_(If using Microsoft/AD/Azure, enforce via policy centrally and screenshot the policy compliance in the admin portal.)_
136-
4. **Automatic Security Updates**
137-
1. **Settings****Update & Security****Windows Update**.
138-
2. Select **Advanced options** → make sure Automatic updates are enabled.\
139-
👉 **Take a screenshot of the Windows Update settings page showing automatic updates turned on.**
140-
5. **Antivirus (Windows Defender)**
141-
1. **Settings****Update & Security****Windows Security**.
142-
2. Open **Virus & threat protection** → ensure **Real-time protection** is on.\
143-
👉 **Take a screenshot of the Windows Security window showing Real-time protection is ON.**
142+
**Enable BitLocker**
143+
144+
1. Press **Start** → type **Manage BitLocker** → open it.\
145+
👉 **Take a screenshot of the BitLocker Drive Encryption window showing “On” for the C: drive.**
146+
2. Select the drive (usually C:) → click **Turn on BitLocker**.
147+
3. Save the recovery key to Microsoft Account / USB / secure location.
148+
4. Restart if prompted.
149+
150+
**Screen Lock after 5 Minutes**
151+
152+
1. Press **Start****Settings****Personalization****Lock screen**.
153+
2. Scroll down → click **Screen timeout settings**.\
154+
👉 **Take a screenshot showing the screen timeout set to 5 minutes.**
155+
3. Set **Screen turns off** = 5 minutes.
156+
4. In **Settings****Accounts****Sign-in options** → ensure **Require sign-in** is set to _“When PC wakes up from sleep”_.\
157+
👉 **Take a screenshot of the Sign-in Options page showing this setting**
158+
159+
**Minimum Password Length (Local Policy)**
160+
161+
1. Press Win + R, type secpol.msc, press Enter.
162+
2. Go to **Account Policies****Password Policy**.
163+
3. Set **Minimum password length** = 8+.\
164+
👉 **Take a screenshot of the Password Policy window with “Minimum password length” = 8 or more.**\
165+
_(If using Microsoft/AD/Azure, enforce via policy centrally and screenshot the policy compliance in the admin portal.)_
166+
167+
**Automatic Security Updates**
168+
169+
1. **Settings****Update & Security****Windows Update**.
170+
2. Select **Advanced options** → make sure Automatic updates are enabled.\
171+
👉 **Take a screenshot of the Windows Update settings page showing automatic updates turned on.**
172+
173+
**Antivirus (Windows Defender)**
174+
175+
1. **Settings****Update & Security****Windows Security**.
176+
2. Open **Virus & threat protection** → ensure **Real-time protection** is on.\
177+
👉 **Take a screenshot of the Windows Security window showing Real-time protection is ON.**
144178

145179
<Note>
146180
Evidence gathered manually will be uploaded as a comment + attachment to the "Secure Devices" & "Device List" tasks with the users email of the device the evidence is for.
@@ -150,31 +184,40 @@ For Mac OS, users must enable MDM to complete the installation process:
150184
<Accordion title="Mac Manual Evidence" description="Evidence to gather manually for unsupported mac devices" icon="sparkles">
151185
### **macOS (Monterey, Ventura, Sonoma)**
152186

153-
1. **Enable FileVault**
154-
1. Open **System Settings** (or **System Preferences** in older versions).
155-
2. Go to **Privacy & Security****FileVault**.
156-
3. Click **Turn On FileVault** → enter password.
157-
4. Record recovery key.\
158-
👉 **Take a screenshot of the FileVault settings page showing “FileVault is enabled for the disk.”**
159-
2. **Screen Auto-lock (5 min)**
160-
1. **System Settings****Lock Screen**.
161-
2. Set **Start screen saver when inactive** = 5 minutes.\
162-
👉 **Take a screenshot showing the setting at 5 minutes.**
163-
3. Set **Require password after sleep or screen saver begins** = _Immediately_.\
164-
👉 **Take a screenshot showing “Require password immediately” is selected.**
165-
3. **Minimum Password Length (Mac Lock Screen PW)**
166-
1. Native macOS UI doesn’t enforce; requires **Terminal** or **MDM**.
167-
2. `pwpolicy -setglobalpolicy "minChars=8"`
168-
3. 👉 **If set via Terminal, take a screenshot of the command output confirming the policy.**
169-
4. If enforced by MDM (Jamf, Intune, etc.), **screenshot the compliance screen from the MDM portal.**
170-
4. **Automatic Security Updates**
171-
1. **System Settings****General****Software Update**.
172-
2. Click **Automatic Updates** → enable all options (Install Security Responses & System files, etc.).\
173-
👉 **Take a screenshot of the Automatic Updates options screen with all toggles enabled.**
174-
5. **Antivirus (XProtect built-in)**
175-
1. macOS automatically runs **XProtect** in the background.
176-
2. Simply ensure macOS is **fully updated**.\
177-
👉 **Take a screenshot of the Software Update page showing the Mac is up to date.**
187+
**Enable FileVault**
188+
189+
1. Open **System Settings** (or **System Preferences** in older versions).
190+
2. Go to **Privacy & Security****FileVault**.
191+
3. Click **Turn On FileVault** → enter password.
192+
4. Record recovery key.\
193+
👉 **Take a screenshot of the FileVault settings page showing “FileVault is enabled for the disk.”**
194+
195+
**Screen Auto-lock (5 min)**
196+
197+
1. **System Settings****Lock Screen**.
198+
2. Set **Start screen saver when inactive** = 5 minutes.\
199+
👉 **Take a screenshot showing the setting at 5 minutes.**
200+
3. Set **Require password after sleep or screen saver begins** = _Immediately_.\
201+
👉 **Take a screenshot showing “Require password immediately” is selected.**
202+
203+
**Minimum Password Length (Mac Lock Screen PW)**
204+
205+
1. Native macOS UI doesn’t enforce; requires **Terminal** or **MDM**.
206+
2. `pwpolicy -setglobalpolicy "minChars=8"`
207+
3. 👉 **If set via Terminal, take a screenshot of the command output confirming the policy.**
208+
4. If enforced by MDM (Jamf, Intune, etc.), **screenshot the compliance screen from the MDM portal.**
209+
210+
**Automatic Security Updates**
211+
212+
1. **System Settings****General****Software Update**.
213+
2. Click **Automatic Updates** → enable all options (Install Security Responses & System files, etc.).\
214+
👉 **Take a screenshot of the Automatic Updates options screen with all toggles enabled.**
215+
216+
**Antivirus (XProtect built-in)**
217+
218+
1. macOS automatically runs **XProtect** in the background.
219+
2. Simply ensure macOS is **fully updated**.\
220+
👉 **Take a screenshot of the Software Update page showing the Mac is up to date.**
178221

179222
<Note>
180223
Evidence gathered manually will be uploaded as a comment + attachment to the "Secure Devices" & "Device List" tasks with the users email of the device the evidence is for.

packages/docs/docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"groups": [
1616
{
1717
"group": "Get Started",
18-
"pages": ["introduction", "quickstart", "development", "device-agent"]
18+
"pages": ["introduction", "automated-evidence", "device-agent"]
1919
}
2020
]
2121
},
85.3 KB
Loading

packages/docs/introduction.mdx

Lines changed: 25 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,40 @@
11
---
2-
title: Introduction
3-
description: 'Welcome to the home of your new documentation'
2+
title: "Welcome to Comp AI"
43
---
54

6-
<img className="block dark:hidden" src="/images/hero-light.png" alt="Hero Light" />
7-
<img className="hidden dark:block" src="/images/hero-dark.png" alt="Hero Dark" />
5+
<img
6+
className="block dark:hidden"
7+
src="/packages/docs/CompAIbackground.jpeg"
8+
alt="Hero Light"
9+
title=""
10+
/>
811

9-
## Setting up
12+
<img
13+
className="hidden dark:block"
14+
src="/packages/docs/CompAIbackground.jpeg"
15+
alt="Hero Dark"
16+
title=""
17+
/>
1018

11-
The first step to world-class documentation is setting up your editing environments.
19+
## Quick Links
20+
21+
Resource links for Comp AI features
1222

1323
<CardGroup cols={2}>
14-
<Card title="Edit Your Docs" icon="pen-to-square" href="https://mintlify.com/docs/quickstart">
15-
Get your docs set up locally for easy development
24+
<Card title="Integrations" href="https://trycomp.ai/docs/integrations">
25+
Connect to cloud providers such as AWS, GCP and Azure
1626
</Card>
17-
<Card title="Preview Changes" icon="image" href="https://mintlify.com/docs/development">
18-
Preview your changes before you push to make sure they're perfect
27+
<Card title="Comp AI Device Agent" href="https://trycomp.ai/docs/device-agent">
28+
Monitor your employee devices with ease with the Comp AI device agent
1929
</Card>
2030
</CardGroup>
2131

22-
## Make it yours
32+
## Build with Comp AI
2333

24-
Update your docs to your brand and add valuable content for the best user conversion.
34+
Comp AI API reference docs
2535

2636
<CardGroup cols={2}>
27-
<Card title="Customize Style" icon="palette" href="https://mintlify.com/docs/settings/global">
28-
Customize your docs to your company's colors and brands
29-
</Card>
30-
<Card title="Reference APIs" icon="code" href="https://mintlify.com/docs/api-playground/openapi">
31-
Automatically generate endpoints from an OpenAPI spec
32-
</Card>
33-
<Card
34-
title="Add Components"
35-
icon="screwdriver-wrench"
36-
href="https://mintlify.com/docs/content/components/accordions"
37-
>
38-
Build interactive features and designs to guide your users
37+
<Card title="API Reference" icon="code" href="https://trycomp.ai/docs/api-reference/organization/get-organization-information">
38+
Build internal tools to help manage evidence collection, policies, employees and more with the Comp AI API
3939
</Card>
40-
<Card title="Get Inspiration" icon="stars" href="https://mintlify.com/customers">
41-
Check out our showcase of our favorite documentation
42-
</Card>
43-
</CardGroup>
40+
</CardGroup>

0 commit comments

Comments
 (0)