Skip to content

Commit 0f009c4

Browse files
puyanguvicpuyanguvic
committed
use vitepress for the web page
1 parent 6446db5 commit 0f009c4

93 files changed

Lines changed: 372 additions & 627 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs-site/.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
dist
2+
.vitepress/cache
3+
.vitepress/temp

‎docs-site/.vitepress/config.mts‎

Lines changed: 179 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
import { defineConfig } from "vitepress";
2+
3+
export default defineConfig({
4+
title: "Argis",
5+
description: "Phish Email Detection Agent documentation",
6+
srcDir: "../docs",
7+
outDir: "dist",
8+
cleanUrls: true,
9+
themeConfig: {
10+
search: {
11+
provider: "local"
12+
},
13+
nav: [
14+
{ text: "Get Started", link: "/get-started/" },
15+
{ text: "Using Argis", link: "/using-argis/" },
16+
{ text: "Configuration", link: "/configuration/" },
17+
{ text: "Releases", link: "/releases/" }
18+
],
19+
sidebar: {
20+
"/get-started/": [
21+
{ text: "Get Started", link: "/get-started/" },
22+
{
23+
text: "Overview",
24+
items: [
25+
{ text: "Overview", link: "/get-started/overview/" },
26+
{ text: "Problem Statement", link: "/get-started/overview/problem-statement" },
27+
{ text: "Threat Landscape", link: "/get-started/overview/threat-landscape" },
28+
{ text: "Design Goals", link: "/get-started/overview/design-goals" }
29+
]
30+
},
31+
{ text: "Quickstart", link: "/get-started/quickstart" },
32+
{
33+
text: "Concepts",
34+
items: [
35+
{ text: "Concepts", link: "/get-started/concepts/" },
36+
{
37+
text: "Architecture",
38+
items: [
39+
{ text: "System Overview", link: "/get-started/concepts/architecture/system-overview" },
40+
{ text: "Agent Components", link: "/get-started/concepts/architecture/agent-components" },
41+
{ text: "Workflow Pipeline", link: "/get-started/concepts/architecture/workflow-pipeline" },
42+
{ text: "Toolchain", link: "/get-started/concepts/architecture/toolchain" },
43+
{ text: "Execution Model", link: "/get-started/concepts/architecture/execution-model" }
44+
]
45+
},
46+
{
47+
text: "Agent",
48+
items: [
49+
{ text: "Roles", link: "/get-started/concepts/agent/roles" },
50+
{ text: "Decision Logic", link: "/get-started/concepts/agent/decision-logic" },
51+
{ text: "Reasoning Policy", link: "/get-started/concepts/agent/reasoning-policy" },
52+
{ text: "Failure Modes", link: "/get-started/concepts/agent/failure-modes" }
53+
]
54+
},
55+
{
56+
text: "Detection Pipeline",
57+
items: [
58+
{ text: "Ingestion", link: "/get-started/concepts/pipeline/ingestion" },
59+
{ text: "Parsing", link: "/get-started/concepts/pipeline/parsing" },
60+
{ text: "Normalization", link: "/get-started/concepts/pipeline/normalization" },
61+
{ text: "Evidence Collection", link: "/get-started/concepts/pipeline/evidence-collection" },
62+
{ text: "Risk Scoring", link: "/get-started/concepts/pipeline/risk-scoring" }
63+
]
64+
},
65+
{
66+
text: "Policies",
67+
items: [
68+
{ text: "Security", link: "/get-started/concepts/policies/security" },
69+
{ text: "Privacy", link: "/get-started/concepts/policies/privacy" },
70+
{ text: "Compliance", link: "/get-started/concepts/policies/compliance" },
71+
{ text: "Escalation", link: "/get-started/concepts/policies/escalation" }
72+
]
73+
},
74+
{
75+
text: "Evaluation",
76+
items: [
77+
{ text: "Metrics", link: "/get-started/concepts/evaluation/metrics" },
78+
{ text: "Benchmarks", link: "/get-started/concepts/evaluation/benchmarks" },
79+
{ text: "Limitations", link: "/get-started/concepts/evaluation/limitations" }
80+
]
81+
},
82+
{
83+
text: "Governance",
84+
items: [
85+
{ text: "Model Updates", link: "/get-started/concepts/governance/model-updates" },
86+
{ text: "Audit Traceability", link: "/get-started/concepts/governance/audit-traceability" }
87+
]
88+
},
89+
{
90+
text: "Protocol",
91+
items: [
92+
{ text: "Protocol v1", link: "/get-started/concepts/protocol/v1" }
93+
]
94+
},
95+
{ text: "Glossary", link: "/get-started/concepts/glossary" },
96+
{
97+
text: "Legacy",
98+
items: [
99+
{ text: "Architecture (Legacy)", link: "/get-started/concepts/legacy/architecture" },
100+
{ text: "Methodology (Legacy)", link: "/get-started/concepts/legacy/methodology" },
101+
{ text: "Threat Model (Legacy)", link: "/get-started/concepts/legacy/threat-model" }
102+
]
103+
}
104+
]
105+
}
106+
],
107+
"/using-argis/": [
108+
{ text: "Using Argis", link: "/using-argis/" },
109+
{ text: "CLI", link: "/using-argis/cli" },
110+
{ text: "Gradio Demo", link: "/using-argis/gradio-demo" },
111+
{
112+
text: "Connectors",
113+
items: [
114+
{ text: "Connectors", link: "/using-argis/connectors/" },
115+
{ text: "IMAP", link: "/using-argis/connectors/imap" },
116+
{ text: "Gmail", link: "/using-argis/connectors/gmail" }
117+
]
118+
},
119+
{
120+
text: "Deployment",
121+
items: [
122+
{ text: "Deployment", link: "/using-argis/deployment/" },
123+
{ text: "Models", link: "/using-argis/deployment/models" },
124+
{ text: "Integration", link: "/using-argis/deployment/integration" },
125+
{ text: "Operations", link: "/using-argis/deployment/operations" }
126+
]
127+
},
128+
{
129+
text: "Reporting",
130+
items: [
131+
{ text: "Reporting", link: "/using-argis/reporting/" },
132+
{ text: "Overview", link: "/using-argis/reporting/overview" },
133+
{ text: "Executive Summary", link: "/using-argis/reporting/executive-summary" },
134+
{ text: "Evidence Table", link: "/using-argis/reporting/evidence-table" },
135+
{ text: "Attack Narrative", link: "/using-argis/reporting/attack-narrative" },
136+
{ text: "Recommendations", link: "/using-argis/reporting/recommendation" },
137+
{ text: "Machine Output", link: "/using-argis/reporting/machine-output" }
138+
]
139+
}
140+
],
141+
"/configuration/": [
142+
{ text: "Configuration", link: "/configuration/" },
143+
{ text: "Config File", link: "/configuration/config-file" },
144+
{ text: "Rules", link: "/configuration/rules" },
145+
{ text: "AGENTS", link: "/configuration/agents-md" },
146+
{ text: "Custom Prompts", link: "/configuration/custom-prompts" },
147+
{ text: "MCP", link: "/configuration/mcp" },
148+
{
149+
text: "Skills",
150+
items: [
151+
{ text: "Skills", link: "/configuration/skills/" },
152+
{ text: "Overview", link: "/configuration/skills/overview" },
153+
{ text: "Brand Impersonation", link: "/configuration/skills/brand-impersonation" },
154+
{ text: "BEC Detection", link: "/configuration/skills/bec-detection" },
155+
{ text: "URL Analysis", link: "/configuration/skills/url-analysis" },
156+
{ text: "Header Forensics", link: "/configuration/skills/header-forensics" },
157+
{ text: "Attachment Analysis", link: "/configuration/skills/attachment-analysis" }
158+
]
159+
},
160+
{
161+
text: "Extending",
162+
items: [
163+
{ text: "Extending", link: "/configuration/extending/" },
164+
{ text: "Code Structure", link: "/configuration/extending/code-structure" },
165+
{ text: "Adding Skills", link: "/configuration/extending/adding-skills" },
166+
{ text: "Adding Tools", link: "/configuration/extending/adding-tools" },
167+
{ text: "Debugging", link: "/configuration/extending/debugging" }
168+
]
169+
}
170+
],
171+
"/releases/": [
172+
{ text: "Releases", link: "/releases/" },
173+
{ text: "Changelog", link: "/releases/changelog" },
174+
{ text: "Feature Maturity", link: "/releases/feature-maturity" },
175+
{ text: "Open Source", link: "/releases/open-source" }
176+
]
177+
}
178+
}
179+
});

‎docs-site/.vitepress/theme/custom.css‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
:root {
2+
--vp-font-family-base: "Iowan Old Style", "Palatino", "Times New Roman", serif;
3+
--vp-font-family-mono: "SFMono-Regular", "Menlo", "Monaco", "Consolas", "Liberation Mono",
4+
"Courier New", monospace;
5+
--vp-c-brand-1: #0c4a6e;
6+
--vp-c-brand-2: #075985;
7+
--vp-c-brand-3: #0369a1;
8+
--vp-c-brand-soft: rgba(3, 105, 161, 0.14);
9+
--vp-c-bg: #f8f4ee;
10+
--vp-c-bg-alt: #f1ece3;
11+
--vp-c-bg-soft: #f6f1e8;
12+
--vp-c-text-1: #1f2937;
13+
--vp-c-text-2: #334155;
14+
--vp-c-text-3: #475569;
15+
--vp-shadow-1: 0 10px 30px rgba(15, 23, 42, 0.08);
16+
}
17+
18+
body {
19+
background:
20+
radial-gradient(1200px 600px at 10% -10%, rgba(14, 116, 144, 0.12), transparent 60%),
21+
radial-gradient(900px 500px at 90% -20%, rgba(2, 132, 199, 0.12), transparent 60%),
22+
var(--vp-c-bg);
23+
}
24+
25+
.VPNavBar {
26+
backdrop-filter: blur(6px);
27+
background-color: rgba(248, 244, 238, 0.75);
28+
border-bottom: 1px solid rgba(15, 23, 42, 0.08);
29+
}
30+
31+
.VPNavBar.has-sidebar {
32+
background-color: rgba(248, 244, 238, 0.9);
33+
}
34+
35+
.VPHome {
36+
background:
37+
linear-gradient(120deg, rgba(3, 105, 161, 0.08), rgba(14, 116, 144, 0.04)),
38+
var(--vp-c-bg);
39+
}
40+
41+
.VPHero .name {
42+
letter-spacing: 0.02em;
43+
text-transform: uppercase;
44+
}
45+
46+
.VPHero .text {
47+
font-weight: 500;
48+
}
49+
50+
.VPFeature {
51+
background-color: var(--vp-c-bg-soft);
52+
border: 1px solid rgba(15, 23, 42, 0.08);
53+
box-shadow: var(--vp-shadow-1);
54+
}
55+
56+
.VPContent .content {
57+
border-radius: 18px;
58+
background: rgba(255, 255, 255, 0.6);
59+
padding: 2.5rem 2rem;
60+
box-shadow: var(--vp-shadow-1);
61+
}
62+
63+
@media (max-width: 960px) {
64+
.VPContent .content {
65+
padding: 2rem 1.5rem;
66+
}
67+
}
68+
69+
@media (max-width: 720px) {
70+
.VPContent .content {
71+
padding: 1.5rem 1.1rem;
72+
}
73+
}

‎docs-site/.vitepress/theme/index.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
import DefaultTheme from "vitepress/theme";
2+
import "./custom.css";
3+
4+
export default DefaultTheme;

‎docs-site/_config.yml‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎docs-site/_data/nav.yml‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎docs-site/_layouts/default.html‎

Lines changed: 0 additions & 72 deletions
This file was deleted.

0 commit comments

Comments
 (0)