Add in-app documentation and update README

caido-community · Sep 6, 2024 · e277f11 · e277f11
1 parent 6b7b3d6
commit e277f11
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -18,16 +18,6 @@
   <hr />
 </div>
 
-# 🔰 StarterKit Plugin
+# 🔰 Authmatrix
 
-This is the starter kit for the Caido plugin system.
-
-This template is full-stack, with both a backend and frontend plugin.
-For frontend only use the [frontend](https://github.com/caido/starterkit-plugin-frontend) starterkit.
-
-## 🏎️ Usage
-
-1. `pnpm install`
-1. Make some modifications in `src`
-1. `pnpm build`
-1. Upload the plugin.zip in the `dist` folder to your Caido instance
+Grid-based authorization testing across multiple users and roles.
diff --git a/packages/frontend/src/components/dashboard/TemplateTable/Container.vue b/packages/frontend/src/components/dashboard/TemplateTable/Container.vue
@@ -106,7 +106,14 @@ const onTemplateUpdate = (
 
       <template #header>
         <div class="px-4 pt-4 flex justify-between gap-8">
-          <div class="flex flex-col gap-2"></div>
+          <div class="flex flex-col">
+            <h2 class="text-lg font-semibold">Templates</h2>
+            <p class="text-sm text-gray-400">Add template requests to the queue for analysis.</p>
+            <p class="text-sm text-gray-400">
+              Specify which roles and users should have access to each resource.
+              Configure a regex to determine if the authentication was successful.
+            </p>
+          </div>
           <div class="flex items-center gap-4">
             <div
               class="flex gap-2"

diff --git a/packages/frontend/src/components/users-roles/RoleList/Container.vue b/packages/frontend/src/components/users-roles/RoleList/Container.vue
@@ -18,9 +18,15 @@ const onAddRole = () => {
 <template>
   <Card class="h-full" :pt="{ body: { class: 'h-full' }, content: { class: 'flex-1 min-h-0' } } ">
     <template #title>
-      <div class="flex justify-between items-center">
-        <h1>Role List</h1>
-        <Button label="+ Add role" @click="onAddRole" />
+      <div class="flex justify-between">
+        <div class="flex flex-col">
+          <h1>Roles</h1>
+          <p class="text-sm text-gray-400">Manage roles and their descriptions</p>
+        </div>
+
+        <div class="min-w-max">
+          <Button label="+ Add role" @click="onAddRole" />
+        </div>
       </div>
     </template>
 

diff --git a/packages/frontend/src/components/users-roles/UserList/Container.vue b/packages/frontend/src/components/users-roles/UserList/Container.vue
@@ -26,9 +26,14 @@ const onAddUser = () => {
 <template>
   <Card class="h-full" :pt="{ body: { class: 'h-full' }, content: { class: 'flex-1 min-h-0' } } ">
     <template #title>
-      <div class="flex justify-between items-center w-full">
-        <h1>User List</h1>
-        <Button label="+ Add User" @click="onAddUser" />
+      <div class="flex justify-between">
+        <div class="flex flex-col w-full">
+          <h1>Users</h1>
+          <p class="text-sm text-gray-400">Manage users and their access to the system</p>
+        </div>
+        <div class="min-w-max">
+          <Button label="+ Add User" @click="onAddUser" />
+        </div>
       </div>
     </template>