Skip to content

Commit aed41b6

Browse files
penguine-ippenguine-ip
committed
updated docs
1 parent 50c3534 commit aed41b6

File tree

5 files changed

+280
-38
lines changed

5 files changed

+280
-38
lines changed

‎docs/docs/getting-started.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import TabItem from "@theme/TabItem";
1717
- Simulate adversarial attacks using 10+ methods including jailbreaking, prompt injection, automated evasion, data extraction, and response manipulation.
1818
- Customize security assessments to align with OWASP Top 10 for LLMs, NIST AI Risk Management, and industry best practices.
1919

20-
Additionally, **DeepTeam is powered by [DeepEval](https://docs.confident-ai.com)**, the open-source LLM evaluation framework. Whilst DeepEval focuses on regular LLM evaluation, DeepTeam is dedicated for red teaming.
20+
Additionally, **DeepTeam is built on [DeepEval](https://docs.confident-ai.com)**, the open-source LLM evaluation framework. Whilst DeepEval focuses on regular LLM evaluation, DeepTeam is dedicated for red teaming.
2121

2222
<Envelope />
2323

‎docs/docusaurus.config.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ const config: Config = {
175175
id: "announcementBar-1",
176176
content:
177177
'⭐️ If you like DeepTeam, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/confident-ai/deepteam">GitHub</a>! ⭐️',
178-
backgroundColor: "#ff006b",
178+
backgroundColor: "#de0064",
179179
textColor: "#000",
180180
},
181181
footer: {

‎docs/src/css/custom.scss‎

Lines changed: 24 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@
88
}
99

1010
:root {
11-
--ifm-color-primary: #ff0062;
12-
--ifm-color-primary-dark: #f6174f;
13-
--ifm-color-primary-darker: #f50a45;
14-
--ifm-color-primary-darkest: #c90839;
15-
--ifm-color-primary-light: #f8517b;
16-
--ifm-color-primary-lighter: #f95f86;
17-
--ifm-color-primary-lightest: #fa8aa6;
11+
--ifm-color-primary: #de0064;
12+
--ifm-color-primary-dark: #c8005a;
13+
--ifm-color-primary-darker: #bd0055;
14+
--ifm-color-primary-darkest: #9b0046;
15+
--ifm-color-primary-light: #f4006e;
16+
--ifm-color-primary-lighter: #ff0073;
17+
--ifm-color-primary-lightest: #ff2285;
1818
--ifm-code-font-size: 85%;
1919
--ifm-menu-color: #747680 !important;
2020
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
@@ -85,13 +85,13 @@
8585

8686
/* For readability concerns, you should choose a lighter palette in dark mode. */
8787
html[data-theme="dark"] {
88-
--ifm-color-primary: #f3154c;
89-
--ifm-color-primary-dark: #f6174f;
90-
--ifm-color-primary-darker: #f50a45;
91-
--ifm-color-primary-darkest: #ff1c55;
92-
--ifm-color-primary-light: #e40545;
93-
--ifm-color-primary-lighter: #ff265c;
94-
--ifm-color-primary-lightest: #fa8aa6;
88+
--ifm-color-primary: #ff0073;
89+
--ifm-color-primary-dark: #e60067;
90+
--ifm-color-primary-darker: #d90062;
91+
--ifm-color-primary-darkest: #b30050;
92+
--ifm-color-primary-light: #ff1a81;
93+
--ifm-color-primary-lighter: #ff2688;
94+
--ifm-color-primary-lightest: #ff4d9d;
9595
--ifm-background-color: #090b0e;
9696
--ifm-background-surface-color: #13171e;
9797
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
@@ -241,12 +241,12 @@ html[data-theme="light"] .navbar__logo {
241241
// Announcement bar
242242
div[role="banner"][class*="announcementBar"] {
243243
font-weight: 600;
244-
background-color: #ff0062 !important;
244+
background-color: #de0064 !important;
245245
color: white !important;
246246
}
247247

248248
html[data-theme="light"] div[role="banner"][class*="announcementBar"] {
249-
background-color: #ff0062 !important;
249+
background-color: #de0064 !important;
250250
color: white !important;
251251
}
252252

@@ -282,26 +282,6 @@ html[data-theme="dark"] .header-github-link:before {
282282
no-repeat;
283283
}
284284

285-
.footer {
286-
background: #0e1015;
287-
}
288-
289-
.footer__copyright {
290-
font-size: 13px;
291-
}
292-
293-
.footer__link-item {
294-
color: #9ca3af;
295-
}
296-
297-
.footer__link-item:hover {
298-
text-decoration: none;
299-
}
300-
301-
.footer__bottom {
302-
margin: 40px auto 10px auto;
303-
}
304-
305285
.header-discord-link:hover {
306286
opacity: 0.6;
307287
}
@@ -646,3 +626,11 @@ html[data-theme="dark"] .header-confident-link:hover {
646626
display: none;
647627
}
648628
}
629+
630+
.pagination-nav__link {
631+
border-radius: 0px;
632+
633+
.pagination-nav__label {
634+
font-weight: 600;
635+
}
636+
}

‎docs/src/theme/Footer/index.tsx‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
import React from "react";
2+
import Link from "@docusaurus/Link";
3+
import styles from "./styles.module.scss";
4+
5+
const LINKS = {
6+
product: [
7+
{ label: "Getting Started", to: "/docs/getting-started" },
8+
{ label: "Vulnerabilities", to: "/docs/red-teaming-vulnerabilities" },
9+
{
10+
label: "Adversarial Attacks",
11+
to: "/docs/red-teaming-adversarial-attacks",
12+
},
13+
{ label: "Guardrails", to: "/docs/guardrails-introduction" },
14+
{ label: "Frameworks", to: "/docs/frameworks-introduction" },
15+
],
16+
reads: [
17+
{
18+
label: "Red Teaming AI Agents",
19+
to: "/guides/guide-agentic-ai-red-teaming",
20+
},
21+
{ label: "Red Teaming RAG", to: "/guides/guide-red-teaming-agentic-rag" },
22+
{ label: "Safety Frameworks", to: "/guides/guide-safety-frameworks" },
23+
{ label: "Building Custom Attacks", to: "/guides/guide-custom-attacks" },
24+
{ label: "Deploying Guardrails", to: "/guides/guide-deploying-guardrails" },
25+
],
26+
ecosystem: [
27+
{ label: "Confident AI", href: "https://www.confident-ai.com" },
28+
{ label: "DeepEval", href: "https://deepeval.com" },
29+
],
30+
};
31+
32+
function GitHubIcon() {
33+
return (
34+
<svg viewBox="0 0 24 24" width="20" height="20" fill="currentColor">
35+
<path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12" />
36+
</svg>
37+
);
38+
}
39+
40+
function Footer() {
41+
return (
42+
<footer className={styles.footer}>
43+
<div className={styles.inner}>
44+
<div className={styles.top}>
45+
<div className={styles.brand}>
46+
<img
47+
src="/icons/DeepTeam.svg"
48+
alt="DeepTeam"
49+
className={styles.logo}
50+
/>
51+
<p className={styles.tagline}>
52+
Open-source LLM red teaming framework. Apache 2.0 licensed.
53+
</p>
54+
<Link
55+
href="https://github.com/confident-ai/deepteam"
56+
className={styles.starButton}
57+
>
58+
<GitHubIcon /> Star us on GitHub
59+
</Link>
60+
</div>
61+
62+
<div className={styles.columns}>
63+
<div className={styles.column}>
64+
<h4 className={styles.columnTitle}>Product</h4>
65+
<ul className={styles.columnList}>
66+
{LINKS.product.map((link) => (
67+
<li key={link.label}>
68+
<Link to={link.to} className={styles.link}>
69+
{link.label}
70+
</Link>
71+
</li>
72+
))}
73+
</ul>
74+
</div>
75+
76+
<div className={styles.column}>
77+
<h4 className={styles.columnTitle}>Very Useful Reads</h4>
78+
<ul className={styles.columnList}>
79+
{LINKS.reads.map((link) => (
80+
<li key={link.label}>
81+
<Link to={link.to} className={styles.link}>
82+
{link.label}
83+
</Link>
84+
</li>
85+
))}
86+
</ul>
87+
</div>
88+
89+
<div className={styles.column}>
90+
<h4 className={styles.columnTitle}>Ecosystem</h4>
91+
<ul className={styles.columnList}>
92+
{LINKS.ecosystem.map((link) => (
93+
<li key={link.label}>
94+
<Link href={link.href} className={styles.link}>
95+
{link.label}
96+
</Link>
97+
</li>
98+
))}
99+
</ul>
100+
</div>
101+
</div>
102+
</div>
103+
104+
<div className={styles.divider} />
105+
106+
<div className={styles.bottom}>
107+
<span className={styles.copyright}>
108+
&copy; {new Date().getFullYear()} Confident AI Inc. Made with 🖤 and
109+
confidence.
110+
</span>
111+
</div>
112+
</div>
113+
114+
{/* <img
115+
src="/icons/DeepTeam.svg"
116+
alt=""
117+
className={styles.wordmark}
118+
aria-hidden="true"
119+
/> */}
120+
</footer>
121+
);
122+
}
123+
124+
export default React.memo(Footer);

‎docs/src/theme/Footer/styles.module.scss‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
.footer {
2+
background: #de0064;
3+
overflow: hidden;
4+
padding: 0;
5+
6+
.inner {
7+
max-width: 1200px;
8+
margin: 0 auto;
9+
padding: 48px 24px 24px;
10+
}
11+
12+
.top {
13+
display: flex;
14+
gap: 64px;
15+
16+
@media (max-width: 768px) {
17+
flex-direction: column;
18+
gap: 40px;
19+
}
20+
}
21+
22+
.brand {
23+
flex-shrink: 0;
24+
width: 350px;
25+
margin-right: 48px;
26+
27+
@media (max-width: 768px) {
28+
max-width: 100%;
29+
}
30+
31+
.logo {
32+
height: 22px;
33+
width: auto;
34+
}
35+
36+
.tagline {
37+
margin: 12px 0 16px;
38+
font-size: 13px;
39+
line-height: 1.5;
40+
color: rgba(255, 255, 255, 0.85);
41+
}
42+
43+
.starButton {
44+
display: inline-flex;
45+
align-items: center;
46+
gap: 8px;
47+
font-size: 13px;
48+
font-weight: 500;
49+
color: #fff;
50+
background: rgba(0, 0, 0, 0.15);
51+
padding: 6px 14px;
52+
transition: background 0.15s;
53+
54+
&:hover {
55+
background: rgba(0, 0, 0, 0.3);
56+
color: #fff;
57+
text-decoration: none;
58+
}
59+
}
60+
}
61+
62+
.columns {
63+
display: flex;
64+
flex: 1;
65+
gap: 40px;
66+
67+
@media (max-width: 768px) {
68+
flex-wrap: wrap;
69+
gap: 32px;
70+
}
71+
72+
.column {
73+
flex: 1;
74+
min-width: 140px;
75+
76+
.columnTitle {
77+
font-size: 13px;
78+
font-weight: 600;
79+
color: rgba(255, 255, 255);
80+
margin: 0 0 12px;
81+
}
82+
83+
.columnList {
84+
list-style: none;
85+
margin: 0;
86+
padding: 0;
87+
display: flex;
88+
flex-direction: column;
89+
gap: 6px;
90+
91+
.link {
92+
font-size: 13px;
93+
color: rgba(255, 255, 255, 0.85);
94+
transition: color 0.15s;
95+
}
96+
}
97+
}
98+
}
99+
100+
.divider {
101+
height: 1px;
102+
background: rgba(255, 255, 255, 0.25);
103+
margin: 32px 0 16px;
104+
}
105+
106+
.bottom {
107+
display: flex;
108+
align-items: center;
109+
justify-content: space-between;
110+
111+
@media (max-width: 768px) {
112+
flex-direction: column;
113+
gap: 8px;
114+
}
115+
116+
.copyright {
117+
font-size: 12px;
118+
color: rgba(255, 255, 255);
119+
}
120+
}
121+
122+
.wordmark {
123+
display: block;
124+
width: 100%;
125+
height: auto;
126+
margin-top: 48px;
127+
opacity: 1;
128+
margin-bottom: -6.5%;
129+
}
130+
}

0 commit comments

Comments
 (0)