Skip to content

Commit cc33075

Browse files
committed
docs(arc-docs): review changes
review changes GH-26
1 parent 24dafe1 commit cc33075

File tree

2 files changed

+40
-17
lines changed

2 files changed

+40
-17
lines changed

projects/arc-docs/src/app/docs/auth-doc/components/configure-token-doc/configure-token-doc.component.html

Lines changed: 39 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,46 @@ <h2 class="nb-card-header-title">
99
<nb-card-body>
1010
<ul>
1111
<li>
12-
At this step,It's time to get a user token but primarly we need a
13-
code with the help of code we call getToken API which returns a
14-
token, after a successful authentication to be able to communicate
15-
with the server and, for instance, show username in the header of
16-
the application
12+
At this step, it's time to get a user token. Primarily, we need a
13+
code. With the help of this code, we call the getToken API, which
14+
returns a token after a successful OAuth 2.0 authentication. This
15+
token will allow us to communicate with the server and, for
16+
instance, display the username in the header of the application.
1717
</li>
1818
<li>
1919
Let's assume that your backend returns a JWT token so that we can
2020
use the token payload to extract user info out of it. Each Strategy
2121
specifies which token class is going to be used by default.
2222
</li>
2323
<li>
24-
For example, NbPasswordAuthStrategy uses AuthToken, and AuthProvider
25-
. It is also possible to specify another token class if it is
26-
required.
24+
This authentication can be managed using different strategies. One
25+
such strategy is NbPasswordAuthStrategy. This strategy typically
26+
involves the use of an AuthToken and an AuthProvider to handle
27+
authentication tasks.
28+
<ul>
29+
<li>
30+
NbPasswordAuthStrategy is a strategy provided by Nebular for
31+
handling password-based authentication. It simplifies the
32+
process of logging in and managing user sessions.
33+
</li>
34+
<img
35+
height="350px"
36+
width="250px"
37+
src="../../.././../../assets/env_img/authmodule.png"
38+
alt="moduleImg"
39+
/>
40+
<li>
41+
AuthToken is used to manage the token received after a
42+
successful authentication. This token is essential for
43+
maintaining a session and authorizing subsequent requests to the
44+
server.
45+
</li>
46+
<li>
47+
AuthProvider is the service responsible for interacting with the
48+
backend server to perform authentication operations such as
49+
login, register, and token refresh.
50+
</li>
51+
</ul>
2752
</li>
2853
</ul>
2954
</nb-card-body>
@@ -35,16 +60,14 @@ <h2 class="nb-card-header-title">Setting a User token</h2>
3560
</nb-card-header>
3661
<nb-card-body>
3762
<p>
38-
When we get token we call authorise method, The authorize method is
39-
part of an authentication service. It is designed to handle the
40-
authorization process using a provided secret (such as an
41-
authorization code). This method initiates a command to obtain tokens,
42-
processes the response, and navigates the user based on the
43-
authorization result.
63+
When we get the token, we call the authorize method. The authorize
64+
method is part of an authentication service, designed to handle the
65+
authorization process. This method initiates a request to obtain
66+
tokens and processes the response.
4467
</p>
4568
<img
4669
height="400px"
47-
width="400px"
70+
width="350px"
4871
src="../../.././../../assets/env_img/method.png"
4972
alt="tokenImg"
5073
/>
@@ -56,7 +79,7 @@ <h2 class="nb-card-header-title">Setting a User token</h2>
5679
</p>
5780

5881
<img
59-
height="300px"
82+
height="250px"
6083
width="350px"
6184
src="../../.././../../assets/env_img/token.png"
6285
alt="tokenImg"

projects/arc/src/app/main/main.component.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {RouteComponentBaseDirective} from '@project-lib/core/route-component-bas
88
import {IconPacksManagerService} from '@project-lib/theme/services';
99
import {COMPONENTS_ITEMS} from './constants/components.constant';
1010
import {NEBULAR_COMP_ITEMS} from './constants/nebularComponents.constants';
11-
import {DOCUMENTATION_MENU_ITEMS} from 'projects/arc-docs/src/app/constants/docs-menu.contant';
11+
import {DOCUMENTATION_MENU_ITEMS} from 'projects/arc-docs/src/app/constants/docs-menu.constant';
1212
import {SIDEBAR_MENU_ITEMS} from '@project-lib/core/constants/sidebar-menu.constant';
1313

1414
@Component({

0 commit comments

Comments
 (0)