Skip to content

Commit 4be302d

Browse files
Corb3nikCorb3nik
authored
Ib diataxis restructure (#135)
* Add tutorials page * Move installation guide to guides/index * Move listening_address reference to guide * Move CA Certification installation reference to guide * Move data location to guide * Move feature docs to guide * Split passive reference article into guide/concept * Move workflow concept articles to own section * MOve convert reference article to MD5 hash tutorial * Rework coding_nodes reference * Move httpql concept to reference * Remove concepts directory * Move files concept to reference * Move Download concept to reference * Fix lint * Move showcase tutorials to Tutorials page * Refactor Quickstart * Move distributions to Guides section * Move common errors reference to troubleshooting guide * Fix deadlinks * Undo AI changes * Fix lint
1 parent 2889048 commit 4be302d

Some content is hidden

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

70 files changed

+550
-1642
lines changed

‎.vitepress/config.mts

+3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import {
55
guidesSidebar,
66
quickstartSidebar,
77
referenceSidebar,
8+
tutorialsSidebar,
89
} from "./sidebars";
910

1011
// https://vitepress.dev/reference/site-config
@@ -45,6 +46,7 @@ export default defineConfig({
4546

4647
nav: [
4748
{ text: "Quickstart", link: "/quickstart/" },
49+
{ text: "Tutorials", link: "/tutorials/" },
4850
{ text: "Guides", link: "/guides/" },
4951
{ text: "Reference", link: "/reference/" },
5052
{ text: "Concepts", link: "/concepts/" },
@@ -57,6 +59,7 @@ export default defineConfig({
5759
"/reference/": referenceSidebar,
5860
"/guides/": guidesSidebar,
5961
"/concepts/": conceptsSidebar,
62+
"/tutorials/": tutorialsSidebar,
6063
},
6164

6265
socialLinks: [

‎.vitepress/sidebars/concepts.ts

+18-36
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,12 @@ import type { DefaultTheme } from "vitepress";
22

33
export const conceptsSidebar: DefaultTheme.SidebarItem[] = [
44
{
5-
text: "Introduction",
5+
text: "Concepts",
66
items: [
77
{
8-
text: "Directory",
8+
text: "Introduction",
99
link: "/concepts/",
1010
},
11-
],
12-
},
13-
{
14-
text: "Essentials",
15-
items: [
1611
{
1712
text: "CLI vs Desktop",
1813
link: "/concepts/essentials/cli_vs_desktop",
@@ -21,24 +16,6 @@ export const conceptsSidebar: DefaultTheme.SidebarItem[] = [
2116
text: "Instances",
2217
link: "/concepts/essentials/instances",
2318
},
24-
{
25-
text: "HTTPQL",
26-
link: "/concepts/essentials/httpql",
27-
},
28-
{
29-
text: "Workflows",
30-
link: "/concepts/essentials/workflows",
31-
items: [
32-
{
33-
text: "Nodes",
34-
link: "/concepts/essentials/workflows/nodes/nodes",
35-
},
36-
{
37-
text: "JavaScript in Caido",
38-
link: "/concepts/essentials/workflows/js_in_caido",
39-
},
40-
],
41-
},
4219
{
4320
text: "Tabs",
4421
link: "/concepts/essentials/tabs",
@@ -50,19 +27,28 @@ export const conceptsSidebar: DefaultTheme.SidebarItem[] = [
5027
],
5128
},
5229
{
53-
text: "Internals",
30+
text: "Workflows",
5431
items: [
5532
{
56-
text: "Files",
57-
link: "/concepts/internals/files",
33+
text: "What are Workflows?",
34+
link: "/concepts/workflows_intro",
5835
},
5936
{
60-
text: "GraphQL",
61-
link: "/concepts/internals/graphql",
37+
text: "Understanding Nodes",
38+
link: "/concepts/workflows_nodes",
6239
},
6340
{
64-
text: "Download",
65-
link: "/concepts/internals/download",
41+
text: "Writing JavaScript",
42+
link: "/concepts/workflows_js",
43+
},
44+
],
45+
},
46+
{
47+
text: "Internals",
48+
items: [
49+
{
50+
text: "GraphQL",
51+
link: "/concepts/internals/graphql",
6652
},
6753
{
6854
text: "Cloud",
@@ -72,10 +58,6 @@ export const conceptsSidebar: DefaultTheme.SidebarItem[] = [
7258
text: "Authentication",
7359
link: "/concepts/internals/authentication",
7460
},
75-
{
76-
text: "Developer",
77-
link: "https://developer.caido.io",
78-
},
7961
],
8062
},
8163
];

‎.vitepress/sidebars/guides.ts

+130-16
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,11 @@ import type { DefaultTheme } from "vitepress";
22

33
export const guidesSidebar: DefaultTheme.SidebarItem[] = [
44
{
5-
text: "Introduction",
6-
items: [
7-
{
8-
text: "Directory",
9-
link: "/guides/",
10-
},
11-
],
12-
},
13-
{
14-
text: "User Guide",
5+
text: "Guides",
156
items: [
167
{
178
text: "Installation",
18-
link: "/guides/user_guide/installation",
9+
link: "/guides/",
1910
},
2011
{
2112
text: "Running on a VPS",
@@ -25,22 +16,145 @@ export const guidesSidebar: DefaultTheme.SidebarItem[] = [
2516
text: "Running in Docker",
2617
link: "/guides/user_guide/docker",
2718
},
19+
{
20+
text: "Troubleshooting",
21+
link: "/guides/troubleshooting",
22+
},
23+
{
24+
text: "Distributions",
25+
items: [
26+
{
27+
text: "Athena OS",
28+
link: "/guides/distributions/athena_os",
29+
},
30+
],
31+
},
32+
],
33+
},
34+
{
35+
text: "Configuration",
36+
items: [
2837
{
2938
text: "Proxying Local Traffic",
3039
link: "/guides/user_guide/proxy_local",
3140
},
41+
{
42+
text: "Changing the Listening Address/Port",
43+
link: "/guides/listening_address",
44+
},
45+
{
46+
text: "Installing the CA Certificate",
47+
link: "/guides/import_ca_certificate",
48+
},
49+
{
50+
text: "Configuring the Data Directory",
51+
link: "/guides/data_location",
52+
},
3253
],
3354
},
3455
{
35-
text: "Workflows",
56+
text: "Features",
3657
items: [
3758
{
38-
text: "JWT Decode",
39-
link: "/guides/workflows/jwt_decode",
59+
text: "Overview",
60+
items: [
61+
{
62+
text: "Sitemap",
63+
link: "/guides/sitemap",
64+
},
65+
{
66+
text: "Sorting",
67+
link: "/guides/sorting",
68+
},
69+
{
70+
text: "Scope",
71+
link: "/guides/scope",
72+
},
73+
{
74+
text: "Filters",
75+
link: "/guides/filters",
76+
},
77+
],
78+
},
79+
{
80+
text: "Proxy",
81+
items: [
82+
{
83+
text: "Intercept",
84+
link: "/guides/intercept",
85+
},
86+
{
87+
text: "HTTP History",
88+
link: "/guides/http_history",
89+
},
90+
{
91+
text: "WS History",
92+
link: "/guides/ws_history",
93+
},
94+
{
95+
text: "Match & Replace",
96+
link: "/guides/match_replace",
97+
},
98+
],
99+
},
100+
{
101+
text: "Testing",
102+
items: [
103+
{
104+
text: "Replay",
105+
link: "/guides/replay",
106+
},
107+
{
108+
text: "Automate",
109+
link: "/guides/automate",
110+
},
111+
{
112+
text: "Workflows",
113+
link: "/guides/workflows",
114+
},
115+
{
116+
text: "Assistant",
117+
link: "/guides/assistant",
118+
},
119+
],
120+
},
121+
{
122+
text: "Logging",
123+
items: [
124+
{
125+
text: "Search",
126+
link: "/guides/search",
127+
},
128+
{
129+
text: "Findings",
130+
link: "/guides/findings",
131+
},
132+
{
133+
text: "Exports",
134+
link: "/guides/exports",
135+
},
136+
],
40137
},
41138
{
42-
text: "Add Header & Resend Request",
43-
link: "/guides/workflows/add_header",
139+
text: "Workspace",
140+
items: [
141+
{
142+
text: "Files",
143+
link: "/guides/files",
144+
},
145+
{
146+
text: "Plugins",
147+
link: "/guides/plugins",
148+
},
149+
{
150+
text: "Projects",
151+
link: "/guides/projects",
152+
},
153+
{
154+
text: "Backups",
155+
link: "/guides/backups",
156+
},
157+
],
44158
},
45159
],
46160
},

‎.vitepress/sidebars/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
export * from "./quickstart";
22
export * from "./reference";
33
export * from "./guides";
4+
export * from "./tutorials";
45
export * from "./concepts";

‎.vitepress/sidebars/quickstart.ts

+1-31
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,12 @@ import type { DefaultTheme } from "vitepress";
22

33
export const quickstartSidebar: DefaultTheme.SidebarItem[] = [
44
{
5-
text: "Welcome",
5+
text: "Quickstart",
66
items: [
77
{
88
text: "Introduction",
99
link: "/quickstart/",
1010
},
11-
{ text: "Showcase", link: "/quickstart/showcase" },
12-
],
13-
},
14-
{
15-
text: "Beginner Guide",
16-
items: [
17-
{
18-
text: "Welcome to Caido",
19-
items: [
20-
{
21-
text: "Onboarding",
22-
link: "/quickstart/beginner_guide/welcome_to_caido/onboarding",
23-
},
24-
],
25-
},
2611
{
2712
text: "Setup",
2813
items: [
@@ -72,19 +57,4 @@ export const quickstartSidebar: DefaultTheme.SidebarItem[] = [
7257
},
7358
],
7459
},
75-
{
76-
text: "Distributions",
77-
link: "/quickstart/distributions",
78-
items: [
79-
{
80-
text: "Linux",
81-
items: [
82-
{
83-
text: "Athena OS",
84-
link: "/quickstart/distributions/linux/athena_os",
85-
},
86-
],
87-
},
88-
],
89-
},
9060
];

0 commit comments

Comments
 (0)