Documentation Overhaul

[dkattan]

This PR implements comprehensive documentation improvements for the ImmyBot documentation site. It adds new user-friendly guides, reorganizes the navigation structure, and expands coverage of key features.

The changes include:

• Updated navigation structure in config.mts
• New overview and getting started guides
• Comprehensive documentation for managing computers and software
• Detailed guides for deployments, tasks, and maintenance
• Troubleshooting and integration documentation
• API and custom integration documentation

Link to Devin run: https://app.devin.ai/sessions/6bf55c095c8746ffafd9660cbeba352b
Requested by: [email protected]

[devin-ai-integration]

Original prompt from [email protected]:

Hey @Devin, please verify that you can:
- access the immense/immybot-documentation repo

[devin-ai-integration]

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

• Address comments on this PR. Add "(aside)" to your comment to have me ignore it.
• Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

• Disable automatic comment and CI monitoring

[Copilot]

Pull Request Overview

This PR implements a comprehensive documentation overhaul for the ImmyBot documentation site by adding new guides and reorganizing the navigation structure. Key changes include new markdown pages covering tasks, tenant management, security software, quick start, computer management, maintenance, integrations, and core concepts, as well as significant updates to the sidebar configuration in .vitepress/config.mts.

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
working-with-tasks.md	New guide detailing how to work with tasks in ImmyBot
tenant-management.md	New comprehensive guide for managing tenants
security-software.md	Detailed instructions on configuring security software
quick-start-guide.md	A guide for getting started quickly with ImmyBot
managing-software.md	New documentation for managing software across environments
managing-computers.md	Guide for computer management including discovery and maintenance
maintenance-updates.md	Comprehensive guide on maintenance sessions and updates
integration-overview.md	Overview of available integrations and their setup procedures
immybot-overview.md	High-level overview of ImmyBot functionality and benefits
first-computer-setup.md	Step-by-step guide for the initial computer setup with ImmyBot
custom-integrations.md	Detailed guide for building custom integrations with ImmyBot
creating-deployments.md	Walkthrough for creating software, task, and configuration deployments
core-concepts.md	Explanation of the key concepts in ImmyBot, including deployments and agents
common-workflows.md	Step-by-step instructions for common tasks such as onboarding and deployment
common-issues.md	Troubleshooting guide addressing frequent issues
.vitepress/config.mts	Updated sidebar configuration reflecting the new documentation structure

Comments suppressed due to low confidence (2)

.vitepress/config.mts:28

• Ensure that the sidebar title 'Getting Started' and its corresponding link items accurately reflect the new documentation structure. Verify that all link paths match the new markdown filenames.

text: 'Getting Started',

.vitepress/config.mts:46

• [nitpick] Consider confirming that the sidebar item labeled 'User Management' with the link '/add-users' is intended for user management documentation; if its content has shifted or been updated, a renaming or link update may be appropriate.

{ text: 'User Management', link: '/add-users' },

[Copilot]

Pull Request Overview

This pull request delivers an extensive overhaul of the ImmyBot documentation site to improve clarity, expand content coverage, and reorganize navigation. Key changes include the addition of new user-friendly guides (Quick Start, Onboarding, ImmyBot Overview, etc.), comprehensive updates to deployment and maintenance topics, and revisions to the navigation structure in the site configuration.

Reviewed Changes

Copilot reviewed 30 out of 30 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
scripts.md	Expanded guide on script creation with best practices and detailed sections.
recommended-deployments.md	Updated and clarified recommended deployment instructions.
quick-start-guide.md	New quick start guide to help users get up and running quickly with ImmyBot.
onboarding.md	Revised onboarding guide with improved step-by-step instructions and images.
managing-software.md	Comprehensive guide on managing software across environments.
managing-computers.md	Detailed instructions on computer management and maintenance with ImmyBot.
maintenance-updates.md	New content covering maintenance sessions and update configuration.
integration-overview.md	Added integration overview describing various tool integration options.
index.md	Updated home page with refreshed hero text and navigation actions.
immybot-overview.md	New overview providing a high-level description of ImmyBot’s capabilities.
getting-started.md	Revised guide to help users understand core concepts and begin using ImmyBot.
first-computer-setup.md	Detailed instructions for setting up the first computer with ImmyBot.
custom-integrations.md	New guide on building custom integrations via API, webhooks, and metascripts.
creating-deployments.md	Step-by-step guide for creating various types of deployments.
core-concepts.md	Overview of core automation concepts including deployments, sessions, agents, etc.
common-workflows.md	Detailed common workflow guides for onboarding, deployment, maintenance, etc.
common-issues.md	Troubleshooting guide covering agents, deployments, integrations, and performance.
add-users.md	Updated guide on adding and managing users in ImmyBot.
FAQ.md	Expanded FAQ addressing licensing, deployment, security, and other common issues.
.vitepress/config.mts	Navigation reorganization reflecting the updated documentation structure.

Comments suppressed due to low confidence (1)

getting-started.md:7

• Consider replacing 'setup' with 'set up' to correctly use the verb phrase in this context.

The goal of ImmyBot is to setup a computer knowing only the customer and the end user.

[dkattan]

Our current API doesn't support pagination but it should

[dkattan]

We mandate authentication against Azure AD/Entra. This is not required to invite users from Azure AD/Entra. However if you don't increase the consent level from the baseline you will need to know the user's id (guid). If you increase it to our recommended default then you can add them from the Persons page.