Skip to content

Combined Documentation Structure Overhaul #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 64 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
64 commits
Select commit Hold shift + click to select a range
46d4397
Update documentation structure and add new content files
devin-ai-integration[bot] Apr 2, 2025
78102e0
Add integration overview documentation
devin-ai-integration[bot] Apr 2, 2025
5e0f809
Add managing computers and software documentation
devin-ai-integration[bot] Apr 2, 2025
b208888
Add creating deployments documentation
devin-ai-integration[bot] Apr 2, 2025
ad8edd4
Add working with tasks documentation
devin-ai-integration[bot] Apr 2, 2025
b2d3d89
Add common issues documentation
devin-ai-integration[bot] Apr 2, 2025
6c6745b
Add security software configuration documentation
devin-ai-integration[bot] Apr 2, 2025
055fad6
Add tenant management documentation
devin-ai-integration[bot] Apr 2, 2025
555dca1
Add maintenance and updates documentation
devin-ai-integration[bot] Apr 2, 2025
ae80ff7
Add API documentation
devin-ai-integration[bot] Apr 2, 2025
ce456ef
Add custom integrations documentation
devin-ai-integration[bot] Apr 2, 2025
1a592fd
Enhance existing documentation files with improved formatting, exampl…
devin-ai-integration[bot] Apr 2, 2025
bbba3a6
Enhance onboarding documentation with improved structure and content
devin-ai-integration[bot] Apr 2, 2025
c08af5d
Enhance recommended deployments documentation with improved structure…
devin-ai-integration[bot] Apr 2, 2025
71941d0
Enhance ImmyBot command reference with improved structure and examples
devin-ai-integration[bot] Apr 2, 2025
183fbbc
Enhance Windows Sandbox documentation with improved structure and bes…
devin-ai-integration[bot] Apr 2, 2025
4f0ebe0
Enhance build-your-own-integration documentation with improved struct…
devin-ai-integration[bot] Apr 2, 2025
44ab524
Update homepage to reflect enhanced documentation structure
devin-ai-integration[bot] Apr 2, 2025
a918ac7
Enhance first-computer-setup and quick-start-guide with valuable info…
devin-ai-integration[bot] Apr 2, 2025
1b78c3c
Fix API documentation to correctly indicate lack of pagination support
devin-ai-integration[bot] Apr 3, 2025
884a673
Update add-users.md to clarify Azure AD/Entra authentication is manda…
devin-ai-integration[bot] Apr 3, 2025
e8b240a
Add actual screenshots for Computers and Deployments pages
devin-ai-integration[bot] Apr 3, 2025
eff546a
Update deployment screenshots with actual application images
devin-ai-integration[bot] Apr 3, 2025
1357618
Add deployment details screenshot
devin-ai-integration[bot] Apr 3, 2025
a058652
Combine documentation structure from PR #47 and PR #54
devin-ai-integration[bot] Apr 8, 2025
ac35ba1
Fix managing-computers.md to accurately reflect actual UI elements
devin-ai-integration[bot] Apr 8, 2025
b735b66
Fix navigation references to accurately reflect actual UI elements
devin-ai-integration[bot] Apr 8, 2025
8d3f220
Fix navigation references to accurately reflect actual UI elements
devin-ai-integration[bot] Apr 8, 2025
b5888ca
Add maintenance-sessions.md to match UI reference
devin-ai-integration[bot] Apr 14, 2025
152158a
Fix tenant creation button label and update deployment links
devin-ai-integration[bot] Apr 15, 2025
e35dd54
Fix maintenance window assignment procedures to match actual UI
devin-ai-integration[bot] Apr 16, 2025
fec83c7
Fix links in deployments.md to point to correct files
devin-ai-integration[bot] Apr 16, 2025
9fba047
Fix navigation references in managing-software.md to match actual UI
devin-ai-integration[bot] Apr 17, 2025
2ca7178
Fix software version addition instructions to match actual UI
devin-ai-integration[bot] Apr 17, 2025
96aee98
Fix Creating Detection Methods and Installation Scripts sections to m…
devin-ai-integration[bot] Apr 17, 2025
8b93374
Fix Creating Software Deployments section to match actual UI
devin-ai-integration[bot] Apr 17, 2025
ed2cce9
Fix Adding New Versions section and update Software Inventory navigat…
devin-ai-integration[bot] Apr 17, 2025
01f148a
Updated FAQ formatting and fixed table of contents on both FAQ and Tr…
Dakota-LM Apr 17, 2025
3132424
Merge branch 'devin/1744124612-combined-documentation' of https://git…
Dakota-LM Apr 17, 2025
f0b493d
Fix links in creating-managing-deployments.md to point to existing files
devin-ai-integration[bot] Apr 17, 2025
7ea839c
Update duplicate Adding New Versions section to Managing Version Updates
devin-ai-integration[bot] Apr 17, 2025
ff69dc7
Fix button label in Creating Basic Software section from Save to Create
devin-ai-integration[bot] Apr 17, 2025
2f65b31
Fix navigation path to Show More > Integrations in tenant-management.md
devin-ai-integration[bot] Apr 17, 2025
c72c3f3
Fix Creating Detection Methods section to add New button step
devin-ai-integration[bot] Apr 17, 2025
0499d4a
Update parent-child relationship description in tenant-management.md
devin-ai-integration[bot] Apr 17, 2025
2250f52
Update Edit tab and Update button in tenant-management.md
devin-ai-integration[bot] Apr 17, 2025
617c32c
Update Tenant Settings section to match actual UI tabs and options
devin-ai-integration[bot] Apr 17, 2025
1494d69
Update Managing Tenant Users section to match actual UI navigation
devin-ai-integration[bot] Apr 17, 2025
c5d88fa
Update Importing Users from Azure AD section to match actual UI navig…
devin-ai-integration[bot] Apr 17, 2025
5d39738
Update Tenant Reporting section to match actual UI navigation
devin-ai-integration[bot] Apr 17, 2025
83d4d98
Update Moving Computers Between Tenants section to use Batch Actions …
devin-ai-integration[bot] Apr 17, 2025
aab1a2b
Update button label from Save to Update in Moving Computers section
devin-ai-integration[bot] Apr 17, 2025
f600294
meta title and heading
hello-jason Apr 21, 2025
072f9b3
Update add-users.md to remove non-existent user management methods
devin-ai-integration[bot] Apr 21, 2025
7acc15c
Clarify people and users relationship in add-users.md
devin-ai-integration[bot] Apr 21, 2025
c34f221
Add Swagger documentation section to api-documentation.md
devin-ai-integration[bot] Apr 21, 2025
e230d76
Update manual identification steps in common-issues.md
devin-ai-integration[bot] Apr 21, 2025
a3c12c9
Update agent identification settings navigation path in common-issues.md
devin-ai-integration[bot] Apr 21, 2025
802c36b
Fix deployment management UI references to match actual application
devin-ai-integration[bot] Apr 21, 2025
d92f5f3
Update deployment creation steps in common-workflows.md to remove non…
devin-ai-integration[bot] Apr 21, 2025
3ab63c3
Update first-computer-setup.md to use 'New' button instead of 'Create…
devin-ai-integration[bot] Apr 22, 2025
fb1cccf
Update add-users.md to include Azure AD integration information
devin-ai-integration[bot] Apr 23, 2025
0a4d3f5
Update support URL to correct domain
devin-ai-integration[bot] Apr 24, 2025
2375d30
Update support URL in troubleshooting.md to correct domain
devin-ai-integration[bot] Apr 24, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 95 additions & 22 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { withMermaid } from "vitepress-plugin-mermaid";

// https://vitepress.dev/reference/site-config
export default withMermaid({
title: "immy.bot",
title: "ImmyBot Technical Documentation",
head: [
['link', { rel: 'icon', href: '/favicon.ico' }],
[
Expand All @@ -25,41 +25,114 @@ 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: 'Introduction to ImmyBot', link: '/introduction' },
{ 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: 'System Requirements', link: '/system-requirements' },
],
},
{
text: 'Integrations',
text: 'Core Features',
collapsed: false,
items: [
{ text: 'Build Your Own', link: '/build-your-own-integration' },
{ text: 'ConnectSecure', link: '/connectsecure-integration-setup' },
{ text: 'ConnectWise Automate', link: '/connectwise-automate-integration-setup' },
{ text: 'ConnectWise Control', link: '/connectwise-control-integration-setup' },
{ text: 'ConnectWise Manage', link: '/connectwise-manage-integration-setup' },
{ text: 'N-Central', link: '/ncentral-integration-setup' },
{ text: 'NinjaRMM', link: '/ninjarmm-integration-setup' },
{ text: 'HaloPSA', link: '/halo-integration-setup' },
{ text: 'Azure', link: '/azure-graph-permissions-setup' },
{ text: 'Tenants & Organizations', link: '/tenants-organizations' },
{ text: 'Computers & Inventory', link: '/computers-inventory' },
{ text: 'Users & Permissions', link: '/users-permissions' },
{ text: 'Software Library', link: '/software-library' },
{ text: 'Maintenance Tasks', link: '/maintenance-tasks' },
{ text: 'Maintenance Sessions', link: '/maintenance-sessions' },
{ text: 'Deployments', link: '/deployments' },
{ text: 'User Affinity', link: '/user-affinity' },
{ text: 'Targets & Targeting', link: '/targets-targeting' },
],
},
{
text: 'Advanced',
text: 'How-To Guides',
collapsed: false,
items: [
{ text: 'Creating & Managing Deployments', link: '/creating-managing-deployments' },
{ text: 'Managing Software', link: '/managing-software' },
{ text: 'Working with Tasks', link: '/working-with-tasks' },
{ text: 'Computer Onboarding', link: '/computer-onboarding' },
{ text: 'Agent Installation', link: '/agent-installation' },
{ text: 'User Management', link: '/add-users' },
{ text: 'Recommended Deployments', link: '/recommended-deployments' },
],
},
{
text: 'Integrations',
collapsed: true,
items: [
{ text: 'Integration Overview', link: '/integration-overview' },
{ text: 'Build Your Own', link: '/build-your-own-integration' },
{
text: 'RMM Integrations',
collapsed: true,
items: [
{ text: 'ConnectWise Automate', link: '/connectwise-automate-integration-setup' },
{ text: 'ConnectWise Control', link: '/connectwise-control-integration-setup' },
{ text: 'N-Central', link: '/ncentral-integration-setup' },
{ text: 'NinjaRMM', link: '/ninjarmm-integration-setup' },
]
},
{
text: 'PSA Integrations',
collapsed: true,
items: [
{ text: 'ConnectWise Manage', link: '/connectwise-manage-integration-setup' },
{ text: 'HaloPSA', link: '/halo-integration-setup' },
]
},
{
text: 'Other Integrations',
collapsed: true,
items: [
{ text: 'Azure', link: '/azure-graph-permissions-setup' },
{ text: 'ConnectSecure', link: '/connectsecure-integration-setup' },
]
},
],
},
{
text: 'Administration',
collapsed: true,
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: 'Advanced Topics',
collapsed: true,
items: [
{ text: 'Scripting Guide', link: '/scripts' },
{ text: 'Metascripts / Cloud Scripts', link: '/immy-commands' },
{ text: 'Deployment Resolution', link: '/deployment-resolution' },
],
},
{
text: 'Troubleshooting',
collapsed: true,
items: [
{ text: 'Common Issues', link: '/common-issues' },
{ text: 'Security Software Configuration', link: '/security-software' },
{ text: 'Agent Troubleshooting', link: '/troubleshooting' },
],
},
{
text: 'Reference',
collapsed: true,
items: [
{ text: 'Terminology', link: '/terminology' },
{ text: 'API Documentation', link: '/api-documentation' },
{ text: 'Release Notes', link: '/releases' },
],
},
{ text: 'Frequently Asked Questions', link: '/FAQ' },
Expand Down
Binary file added .vitepress/images/computers/computer-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .vitepress/images/computers/computer-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .vitepress/images/computers/computer-software.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading