Documentation Overhaul

.vitepress/config.mts

@@ -25,24 +25,33 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
         // https://vitepress.dev/reference/default-theme-config
         sidebar: [
             {
-                text: 'Introduction',
+                text: 'Getting Started',
                 collapsed: false,
                 items: [
-                    { text: 'Getting Started', link: '/getting-started' },
-                    { text: 'What\'s New', link: '/releases' },
-                    { text: 'Add Users', link: './add-users' },
-                    { text: 'Onboarding', link: './onboarding' },
-                    { text: 'Recommended Deployments', link: './recommended-deployments' },
-                    { text: 'Terminology', link: './terminology' },
-                    { text: 'Troubleshooting', link: './troubleshooting' },
-                    { text: 'User Roles', link: './user-roles' },
-                    { text: 'Windows Sandbox', link: './windows-sandbox' },
+                    { text: 'ImmyBot Overview', link: '/immybot-overview' },
+                    { text: 'Quick Start Guide', link: '/quick-start-guide' },
+                    { text: 'First Computer Setup', link: '/first-computer-setup' },
+                    { text: 'Core Concepts', link: '/core-concepts' },
+                    { text: 'Common Workflows', link: '/common-workflows' },
+                ],
+            },
+            {
+                text: 'User Guides',
+                collapsed: false,
+                items: [
+                    { text: 'Managing Computers', link: '/managing-computers' },
+                    { text: 'Managing Software', link: '/managing-software' },
+                    { text: 'Creating Deployments', link: '/creating-deployments' },
+                    { text: 'Working with Tasks', link: '/working-with-tasks' },
+                    { text: 'User Management', link: '/add-users' },
+                    { text: 'Recommended Configurations', link: '/recommended-deployments' },
                 ],
             },
             {
                 text: 'Integrations',
                 collapsed: false,
                 items: [
+                    { text: 'Integration Overview', link: '/integration-overview' },
                     { text: 'Build Your Own', link: '/build-your-own-integration' },
                     { text: 'ConnectSecure', link: '/connectsecure-integration-setup' },
                     { text: 'ConnectWise Automate', link: '/connectwise-automate-integration-setup' },
@@ -55,11 +64,40 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
                 ],
             },
             {
-                text: 'Advanced',
+                text: 'Administration',
+                collapsed: false,
+                items: [
+                    { text: 'User Roles and Security', link: '/user-roles' },
+                    { text: 'Tenant Management', link: '/tenant-management' },
+                    { text: 'Maintenance and Updates', link: '/maintenance-updates' },
+                    { text: 'Windows Sandbox', link: '/windows-sandbox' },
+                ],
+            },
+            {
+                text: 'Troubleshooting',
+                collapsed: false,
+                items: [
+                    { text: 'Common Issues', link: '/common-issues' },
+                    { text: 'Security Software Configuration', link: '/security-software' },
+                    { text: 'Agent Troubleshooting', link: '/troubleshooting' },
+                ],
+            },
+            {
+                text: 'Advanced Topics',
                 collapsed: false,
                 items: [
                     { text: 'Scripting Guide', link: '/scripts' },
                     { text: 'Metascripts / Cloud Scripts', link: '/immy-commands' },
+                    { text: 'Custom Integrations', link: '/custom-integrations' },
+                ],
+            },
+            {
+                text: 'Reference',
+                collapsed: false,
+                items: [
+                    { text: 'Terminology', link: '/terminology' },
+                    { text: 'API Documentation', link: '/api-documentation' },
+                    { text: 'Release Notes', link: '/releases' },
                 ],
             },
             { text: 'Frequently Asked Questions', link: '/FAQ' },

FAQ.md

@@ -1,11 +1,25 @@
+# Frequently Asked Questions
+
 ::: warning *ImmyBot's EV code-signing certificate is changing on Feb. 11th, 2025*
-Please see the [FAQ section for more details](https://docs.immy.bot/FAQ.html#what-should-i-do-about-immybot-s-upcoming-code-signing-certificate-change) on updating security exclusions.
+Please see the [section below](#what-should-i-do-about-immybots-upcoming-code-signing-certificate-change) for more details on updating security exclusions.
 :::
 
 ::: danger *ImmyBot no longer supports Windows 7, Server 2008 (or Server 2012 w/o [ESUs](https://learn.microsoft.com/en-us/windows-server/get-started/extended-security-updates-overview)) machines.*
-Please see the [FAQ section for more details](https://docs.immy.bot/FAQ.html#what-windows-versions-does-immyagent-support)
+Please see the [section below](#what-windows-versions-does-immyagent-support) for more details.
 :::
-# Frequently Asked Questions
+
+This comprehensive FAQ addresses common questions about ImmyBot, including licensing, deployment, configuration, and troubleshooting. If you don't find the answer to your question here, please check our [Common Issues](./common-issues.md) guide or contact our [support team](mailto:[email protected]).
+
+## Table of Contents
+
+- [Licensing and Plans](#what-is-the-difference-between-the-starter-and-standard-plan)
+- [Deployment and Configuration](#do-i-need-a-separate-usbinstaller-per-tenant)
+- [Security and Certificates](#what-should-i-do-about-immybots-upcoming-code-signing-certificate-change)
+- [Operating System Support](#what-windows-versions-does-immyagent-support)
+- [Integration with Other Tools](#can-immy-join-azuread)
+- [Agent Management](#how-do-i-uninstall-the-immyagent)
+- [Troubleshooting](#why-are-my-computers-stuck-in-identification)
+
 
 ## What is the difference between the Starter and Standard plan?
 
@@ -256,16 +270,37 @@ DISM.exe /Image:D:\mount /Add-ProvisioningPackage /PackagePath:C:\Users\Moi\Down
 
 ## Do you take requests for features/software/tasks/scripts?
 
-Yes, please feel welcome to submit a request on the [ImmyBot Community](https://community.immy.bot)
-
+Yes, we welcome feature requests and contributions from our community! Please submit your requests on the [ImmyBot Community](https://community.immy.bot) portal. Our team regularly reviews these requests and prioritizes them based on user demand and alignment with our product roadmap.
 
 ## Where do I find a file that was uploaded to a computer through ImmyBot Remote Control?
 
-Files uploaded through ImmyBot Remote Control can be found at %ProgramData%\RemoteControl\Shared
+Files uploaded through ImmyBot Remote Control are stored in a specific location on the target computer:
+
+```
+%ProgramData%\RemoteControl\Shared
+```
+
+This folder contains all files transferred during remote control sessions. You can access this location directly through File Explorer or by running a command prompt and navigating to the directory.
 
 ## Why am I getting this system update notification?
 
-We have something new and cool, be it a feature or bug fix!
-The system updates usually take 5-10 minutes to apply and restart your instance.  During this time your instance will not be accessible.
-There are no sessions triggered on any endpoints as a result of the update, and if there are any sessions running when the update starts they will be restarted after the update completes.
-If you prefer not to think about doing updates, you can also schedule a time for automatic system updates to happen under Show More > Preferences.
+System update notifications indicate that we've released new features or bug fixes for your ImmyBot instance. Here's what you need to know:
+
+- Updates typically take 5-10 minutes to apply and restart your instance
+- During the update, your instance will not be accessible
+- No maintenance sessions are triggered on endpoints as a result of the update
+- Any running sessions will be restarted after the update completes
+
+If you prefer to automate updates, you can schedule a time for automatic system updates under **Show More** > **Preferences**. This allows you to set updates to occur during non-business hours to minimize disruption.
+
+## Next Steps
+
+After reviewing these FAQs, you might want to explore:
+
+- [Common Issues](./common-issues.md) - Solutions to frequently encountered problems
+- [Troubleshooting Guide](./troubleshooting.md) - Detailed troubleshooting steps
+- [ImmyBot Overview](./immybot-overview.md) - Learn more about ImmyBot's capabilities
+
+---
+
+**Next Steps:** [Common Issues →](./common-issues.md) | [Troubleshooting Guide →](./troubleshooting.md)

add-users.md

@@ -1,9 +1,89 @@
 # Adding Users
 
-Have the person attempt to login to ImmyBot. Have them request access:
+This guide explains how to add and manage users in ImmyBot, including different authentication methods and role assignments.
 
-![image](https://user-images.githubusercontent.com/1424395/153074628-4a22c81a-177e-4ebb-9845-898ab0f95d88.jpeg)
+## User Authentication Methods
 
-Approve that access from a yellow indicator at the top of the screen.
+ImmyBot mandates authentication against Azure AD/Entra ID:
 
-![image](https://immybot.blob.core.windows.net/release-media/bb34184f-c7c3-41cf-9fa3-f6489e6c3600)
+1. **Azure AD/Entra ID Integration**: Required for all ImmyBot installations
+2. **Email Invitation**: Available for inviting users already in your Azure AD/Entra directory
+3. **Self-Registration**: Allow users to request access (with admin approval)
+
+## Adding Users via Self-Registration
+
+The simplest way to add users is through self-registration:
+
+1. Have the person navigate to your ImmyBot instance (e.g., `https://yourdomain.immy.bot`)
+2. They will see a login screen where they can request access:
+
+![User requesting access](https://user-images.githubusercontent.com/1424395/153074628-4a22c81a-177e-4ebb-9845-898ab0f95d88.jpeg)
+
+3. As an administrator, you'll see a yellow notification indicator at the top of your screen
+4. Click the notification to review and approve the access request:
+
+![Approving access request](https://immybot.blob.core.windows.net/release-media/bb34184f-c7c3-41cf-9fa3-f6489e6c3600)
+
+5. Select the appropriate role for the user (see [User Roles and Security](./user-roles.md) for details)
+6. Click **Approve** to grant access
+
+## Adding Users via Email Invitation
+
+For more controlled user addition:
+
+1. Navigate to **Settings** > **Users**
+2. Click **Invite User**
+3. Enter the user's email address
+4. Select the appropriate role
+5. (Optional) Assign the user to specific tenants
+6. Click **Send Invitation**
+7. The user will receive an email with instructions to complete registration
+
+## Adding Users via Azure AD/Entra ID
+
+Azure AD/Entra ID integration is mandatory for ImmyBot authentication:
+
+1. Navigate to **Settings** > **Authentication** to configure your Azure AD/Entra integration
+2. There are two ways to add users from Azure AD/Entra:
+   - **Basic Consent Level**: You'll need to know the user's ID (GUID) to add them
+   - **Recommended Consent Level**: Users can be added directly from the Persons page without knowing their GUID
+3. To increase the consent level to recommended settings:
+   - Navigate to **Settings** > **Authentication** > **Azure AD**
+   - Click on **Increase Consent Level**
+   - Follow the prompts to grant additional permissions
+4. Users can now sign in with their Microsoft credentials
+5. Assign appropriate roles to new users after they sign in
+
+## Managing Existing Users
+
+To manage existing users:
+
+1. Navigate to **Settings** > **Users**
+2. View the list of all users in your ImmyBot instance
+3. Click on a user to edit their details:
+   - Change their role
+   - Adjust tenant access
+   - Enable/disable account
+   - Reset password
+
+## Best Practices
+
+Follow these best practices for user management:
+
+1. **Principle of Least Privilege**: Assign the minimum necessary permissions
+2. **Regular Audits**: Periodically review user accounts and permissions
+3. **Offboarding Process**: Disable accounts promptly when users leave
+4. **Role-Based Access**: Use roles to manage permissions consistently
+5. **Documentation**: Maintain documentation of who has access and why
+
+## Next Steps
+
+After adding users, you might want to explore:
+
+- [User Roles and Security](./user-roles.md) - Learn about user permissions and security
+- [Tenant Management](./tenant-management.md) - Configure tenant access for users
+- [Azure AD/Entra ID Integration](./azure-graph-permissions-setup.md) - Configure Azure AD/Entra permissions
+
+---
+
+**Next Steps:** [User Roles and Security →](./user-roles.md) | [Tenant Management →](./tenant-management.md)