Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
daftspunk committed May 6, 2024
1 parent 3d6d059 commit 78a2b15
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 6 deletions.
2 changes: 1 addition & 1 deletion components/Account.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public function componentDetails()
{
return [
'name' => "Account",
'description' => "User management form."
'description' => "User management form for updating profile and security details."
];
}

Expand Down
2 changes: 1 addition & 1 deletion components/Session.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public function componentDetails()
{
return [
'name' => "Session",
'description' => "Provides services for registering a user."
'description' => "Checks the user session and includes the user object on the page."
];
}

Expand Down
8 changes: 8 additions & 0 deletions docs/docs-lock.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,27 @@
"children": [
{
"title": "Session",
"description": "checks the user session and includes the user object on the page",
"slug": "component-session"
},
{
"title": "Account",
"description": "user management form for updating profile and security details",
"slug": "component-account"
},
{
"title": "Authentication",
"description": "provides services for logging a user in",
"slug": "component-authentication"
},
{
"title": "Registration",
"description": "provides services for registering a user",
"slug": "component-registration"
},
{
"title": "Reset Password",
"description": "confirms and resets the user with a new password",
"slug": "component-reset-password"
}
]
Expand All @@ -43,14 +48,17 @@
"children": [
{
"title": "Auth Manager",
"description": "services for managing the user session",
"slug": "auth-manager"
},
{
"title": "Impersonation",
"description": "extra services for impersonating users",
"slug": "auth-impersonation"
},
{
"title": "Bearer Tokens",
"description": "extra services for JWT authentication",
"slug": "auth-bearer-tokens"
}
]
Expand Down
12 changes: 8 additions & 4 deletions docs/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,31 +22,35 @@ navigation:
-
title: "Session"
link: "./component-session.md"

description: "checks the user session and includes the user object on the page"
-
title: "Account"
link: "./component-account.md"

description: "user management form for updating profile and security details"
-
title: "Authentication"
link: "./component-authentication.md"

description: "provides services for logging a user in"
-
title: "Registration"
link: "./component-registration.md"

description: "provides services for registering a user"
-
title: "Reset Password"
link: "./component-reset-password.md"
description: "confirms and resets the user with a new password"
-
title: "Services"
children:
-
title: "Auth Manager"
link: "./auth-manager.md"
description: "services for managing the user session"
-
title: "Impersonation"
link: "./auth-impersonation.md"
description: "extra services for impersonating users"
-
title: "Bearer Tokens"
link: "./auth-bearer-tokens.md"
description: "extra services for JWT authentication"

0 comments on commit 78a2b15

Please sign in to comment.