Skip to content

Commit f99bec3

Browse files
authored
feat: add user docs (#392)
* feat: add user docs * ch: change slug
1 parent 9f85ac2 commit f99bec3

File tree

3 files changed

+44
-0
lines changed

3 files changed

+44
-0
lines changed

Diff for: src/components/Docs/SideBarDocs.tsx

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ function SideBarDocs() {
77
return (
88
<section className = "py-8 px-5 ">
99
<ul className ="p-2 flex flex-col gap-4" >
10+
<NavLink className={(navData) => {if (navData.isActive) return 'text-primary'; return ''}} to='/docs/getting-started'>Getting started (new users)</NavLink>
1011
<NavLink
1112
className={(navData) => {
1213
if (navData.isActive) return 'text-primary';

Diff for: src/components/Docs/users.tsx

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
import React from 'react'
2+
import DocsMain from './DocsMain'
3+
4+
const UsersDocs = () => {
5+
return (
6+
<div>
7+
<DocsMain
8+
content={
9+
<div className="flex items-start box-border">
10+
<div className="w-full">
11+
<div className=" w-full sm:px-10 mb-10 text-gray-600 dark:text-slate-300 text-lg ml-0 pt-4">
12+
<h2 className="mb-4 mt-4 text-4xl font-[800] text-primary">
13+
Getting started
14+
</h2>
15+
<div className="mt-5 w-[100%] sm:w-full mb-4">
16+
Devpulse is a semi-open platform i.e. using it, requires a certain level of approval from the owners/managers. If you browse the homepage, you might wonder why there is no signup button, this is because to sign up you need an invitation.
17+
<h3 className="m-2 mb-4 text-2xl font-bold">
18+
Terminology to be familiar with:</h3>
19+
<ul className=" list-disc ml-12">
20+
21+
<li><b>Organizations</b>: each Devpulse user belongs to an organization. The default organization is Andela. The admin of a given organisation has the highest privilege; they are the one in charge of managing the rest of the users and different administrative tasks</li>
22+
23+
<li><b>Programs</b>: each organization should have a program that it is running.</li>
24+
<li><b>Managers:</b> each program should have managers with different access levels. (coordinators, technical team leads, managers)</li>
25+
<li><b>Trainees:</b> an ordinary user of the app will fall under the role of a trainee. As a trainee, you belong to a team, which in turn belongs to a cohort, which in turn belongs to a program</li>
26+
</ul>
27+
28+
<h3 className="m-2 mb-4 text-2xl font-bold">Signing up as a user</h3>
29+
<p>To sign up, <b><u>your org admin must send you an invite</u></b>. The invitation email will contain the details of how to sign up</p>
30+
<h3 className="m-2 mb-4 text-2xl font-bold">Signing in as a user</h3>
31+
<p>To sign in, go to the signin page, provide the correct name of your organization, on the next screen enter username and password.</p>
32+
</div>
33+
</div>
34+
</div>
35+
</div>
36+
}
37+
/>
38+
</div>
39+
)
40+
}
41+
export default UsersDocs

Diff for: src/containers/Routes.tsx

+2
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ const SignupOrgDocs = React.lazy(
3232
const SigninOrgDocs = React.lazy(
3333
() => import('../components/Docs/SigninOrgDocs'),
3434
);
35+
const UsersDocs = React.lazy( () => import ('../components/Docs/users'),)
3536
/* istanbul ignore next */
3637
import Noredirect from '../pages/Noredirect';
3738
import ProtectedRoutes from '../ProtectedRoute';
@@ -90,6 +91,7 @@ function MainRoutes() {
9091
/>
9192
<Route path="/docs/org-signup" element={<SignupOrgDocs />} />
9293
<Route path="/docs/org-signin" element={<SigninOrgDocs />} />
94+
<Route path='/docs/users' element={< UsersDocs />} />
9395
<Route path="/noredirect" element={<Noredirect />} />
9496
</Route>
9597
<Route path="*" element={<Error />} />

0 commit comments

Comments
 (0)