User Guide improvements

Blazam-App · Oct 22, 2024 · 08a105a · 08a105a
1 parent 7214d31
commit 08a105a
Show file tree

Hide file tree

Showing 6 changed files with 126 additions and 2 deletions.
diff --git a/.vs/docs.blazam.org/v17/.wsuo b/.vs/docs.blazam.org/v17/.wsuo
diff --git a/.vs/slnx.sqlite b/.vs/slnx.sqlite
diff --git a/docs/search/search_index.json b/docs/search/search_index.json
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
diff --git a/docs/user/index.html b/docs/user/index.html
@@ -840,6 +840,54 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#universal-search" class="md-nav__link">
+    <span class="md-ellipsis">
+      Universal Search
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="Universal Search">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#search-type" class="md-nav__link">
+    <span class="md-ellipsis">
+      Search Type
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#enabled-only" class="md-nav__link">
+    <span class="md-ellipsis">
+      Enabled Only
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="Enabled Only">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#search-box" class="md-nav__link">
+    <span class="md-ellipsis">
+      Search Box
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
       </ul>
@@ -989,6 +1037,54 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#universal-search" class="md-nav__link">
+    <span class="md-ellipsis">
+      Universal Search
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="Universal Search">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#search-type" class="md-nav__link">
+    <span class="md-ellipsis">
+      Search Type
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#enabled-only" class="md-nav__link">
+    <span class="md-ellipsis">
+      Enabled Only
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="Enabled Only">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#search-box" class="md-nav__link">
+    <span class="md-ellipsis">
+      Search Box
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
       </ul>
@@ -1040,6 +1136,18 @@ <h3 id="dashboard-widgets">Dashboard Widgets</h3>
 * Locked Out Users
 * Favorites
 * Application Logons (Super-admins only)</p>
+<h3 id="universal-search">Universal Search</h3>
+<h4 id="search-type">Search Type</h4>
+<p>By default Blazam searches all Active Directory object types. To narrow your search, use the type filter
+to specify the object type you are looking for.</p>
+<h3 id="enabled-only">Enabled Only</h3>
+<p>When green the search will only return enabled accounts (Users and computers), otherwise disabled
+accounts will be included in search results.</p>
+<h4 id="search-box">Search Box</h4>
+<p>The search box in the center of the AppBar is the key tool for navigating Blazam.
+Auto-complete searches are performed, respecting the type filter, against all accessible
+AD objects. </p>
+<p>Searches are currently performed against the first name, last name, display name, and username, emails are excluded.</p>
 
 
 

diff --git a/docsource/user/index.md b/docsource/user/index.md
@@ -21,4 +21,20 @@ The full set of widgets are:
 * Changed Passwords
 * Locked Out Users
 * Favorites
-* Application Logons (Super-admins only)
+* Application Logons (Super-admins only)
+
+### Universal Search
+#### Search Type
+By default Blazam searches all Active Directory object types. To narrow your search, use the type filter
+to specify the object type you are looking for.
+
+### Enabled Only
+When green the search will only return enabled accounts (Users and computers), otherwise disabled
+accounts will be included in search results.
+
+#### Search Box
+The search box in the center of the AppBar is the key tool for navigating Blazam.
+Auto-complete searches are performed, respecting the type filter, against all accessible
+AD objects. 
+
+Searches are currently performed against the first name, last name, display name, and username, emails are excluded.