Skip to content

Commit 4678d52

Browse files
Corb3nikCorb3nik
authored
Add AI Generated guides (#81)
* First guide draft * Update doc titles * Add descriptions to examples * Migrate examples to use vue components * Move examples to own section * Update dialog guide * Re-organize sidebar * Fix titles * ... * Improve subsection names * improve view mode guide * Improve info block placement * Improve command palette page * Update scopes guide * Remove graphql guide
1 parent e579751 commit 4678d52

Some content is hidden

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

42 files changed

+4347
-348
lines changed

‎.vitepress/sidebars/guides.ts‎

Lines changed: 196 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -9,132 +9,225 @@ export const guidesSidebar: DefaultTheme.SidebarItem[] = [
99
link: "/guides/",
1010
},
1111
{
12-
text: "Configuring Your Package",
12+
text: "Configure Package",
1313
link: "/guides/config",
1414
},
1515
{
1616
text: "AI Assisted Coding",
1717
link: "/guides/vibe_coding",
1818
},
19-
],
20-
},
21-
{
22-
text: "Building User Interfaces",
23-
items: [
24-
{
25-
text: "Creating a Page",
26-
link: "/guides/page",
27-
},
28-
{
29-
text: "Creating a Command",
30-
link: "/guides/command",
31-
},
32-
{
33-
text: "Customizing Context Menus",
34-
link: "/guides/menu",
35-
},
36-
{
37-
text: "Using the Component Library",
38-
link: "/guides/styling",
39-
},
40-
],
41-
},
42-
{
43-
text: "Working with HTTP",
44-
items: [
45-
{
46-
text: "Sending HTTP Requests",
47-
link: "/guides/request",
48-
},
49-
{
50-
text: "Sending a Fetch Request",
51-
link: "/guides/fetch",
52-
},
53-
{
54-
text: "Fetching Proxied Requests",
55-
link: "/guides/querying_requests",
56-
},
57-
{
58-
text: "Using Invalid UTF-8",
59-
link: "/guides/utf",
60-
},
61-
],
62-
},
63-
{
64-
text: "Working with Caido Features",
65-
items: [
66-
{
67-
text: "Using Findings",
68-
link: "/guides/findings",
69-
},
7019
{
71-
text: "Using Environment Variables",
72-
link: "/guides/env",
73-
},
74-
],
75-
},
76-
{
77-
text: "Storing Data",
78-
items: [
79-
{
80-
text: "Storing Frontend Data",
81-
link: "/guides/frontend_storage",
82-
},
83-
{
84-
text: "Storing Data in SQLite",
85-
link: "/guides/sqlite",
86-
},
87-
{
88-
text: "Adding Files",
89-
link: "/guides/files",
90-
},
91-
],
92-
},
93-
{
94-
text: "Communication & Events",
95-
items: [
96-
{
97-
text: "Creating and Calling a Custom Function",
98-
link: "/guides/rpc",
20+
text: "Set Up Repository",
21+
link: "/guides/repository",
9922
},
10023
{
101-
text: "Handling Backend Events",
102-
link: "/guides/backend_events",
24+
text: "Submit to Store",
25+
link: "/guides/store",
10326
},
10427
{
105-
text: "Sending Events to the Frontend",
106-
link: "/guides/events",
107-
},
108-
],
109-
},
110-
{
111-
text: "System Integration",
112-
items: [
113-
{
114-
text: "Spawning a Process",
115-
link: "/guides/spawning_process",
28+
text: "Contributing",
29+
link: "/guides/documentation",
11630
},
11731
],
11832
},
11933
{
120-
text: "Distribution",
34+
text: "Frontend Guides",
12135
items: [
12236
{
123-
text: "Setting Up Your Repository",
124-
link: "/guides/repository",
125-
},
126-
{
127-
text: "Submitting to the Store",
128-
link: "/guides/store",
37+
text: "User Interface",
38+
items: [
39+
{
40+
text: "Create a Page",
41+
link: "/guides/page",
42+
},
43+
{
44+
text: "Create a Command",
45+
link: "/guides/command",
46+
},
47+
{
48+
text: "Customize Context Menus",
49+
link: "/guides/menu",
50+
},
51+
{
52+
text: "Use the Component Library",
53+
link: "/guides/styling",
54+
},
55+
{
56+
text: "Extend Editors",
57+
link: "/guides/editor_extensions",
58+
},
59+
{
60+
text: "Add View Modes",
61+
link: "/guides/view_modes",
62+
},
63+
{
64+
text: "Add to UI Slots",
65+
link: "/guides/slots",
66+
},
67+
{
68+
text: "Show Dialogs",
69+
link: "/guides/dialogs",
70+
},
71+
{
72+
text: "Register Shortcuts",
73+
link: "/guides/shortcuts",
74+
},
75+
{
76+
text: "Customize the Command Palette",
77+
link: "/guides/command_palette_advanced",
78+
},
79+
],
80+
},
81+
{
82+
text: "Data Storage",
83+
items: [
84+
{
85+
text: "Store Frontend Data",
86+
link: "/guides/frontend_storage",
87+
},
88+
{
89+
text: "Access Static Assets",
90+
link: "/guides/assets",
91+
},
92+
],
93+
},
94+
{
95+
text: "Caido Features",
96+
items: [
97+
{
98+
text: "Use HTTPQL Queries",
99+
link: "/guides/filters",
100+
},
101+
{
102+
text: "Manage Scopes",
103+
link: "/guides/scopes",
104+
},
105+
{
106+
text: "Manage Replay Sessions",
107+
link: "/guides/replay",
108+
},
109+
{
110+
text: "Manage Match and Replace",
111+
link: "/guides/match_replace",
112+
},
113+
{
114+
text: "Interact with Workflows",
115+
link: "/guides/workflows",
116+
},
117+
],
118+
},
119+
{
120+
text: "Events",
121+
items: [
122+
{
123+
text: "Subscribe to Application Events",
124+
link: "/guides/application_events",
125+
},
126+
{
127+
text: "Listen to Navigation Events",
128+
link: "/guides/navigation_events",
129+
},
130+
],
131+
},
132+
{
133+
text: "System Integration",
134+
items: [
135+
{
136+
text: "Log Messages",
137+
link: "/guides/log",
138+
},
139+
{
140+
text: "Get Version Information",
141+
link: "/guides/runtime",
142+
},
143+
],
144+
},
145+
{
146+
text: "Advanced Features",
147+
items: [
148+
{
149+
text: "Use AI in Your Plugin",
150+
link: "/guides/ai",
151+
},
152+
],
129153
},
130154
],
131155
},
132156
{
133-
text: "Contributions",
157+
text: "Backend Guides",
134158
items: [
135159
{
136-
text: "Documentation",
137-
link: "/guides/documentation",
160+
text: "Working with HTTP",
161+
items: [
162+
{
163+
text: "Send HTTP Requests",
164+
link: "/guides/request",
165+
},
166+
{
167+
text: "Send a Fetch Request",
168+
link: "/guides/fetch",
169+
},
170+
{
171+
text: "Fetch Proxied Requests",
172+
link: "/guides/querying_requests",
173+
},
174+
{
175+
text: "Use Invalid UTF-8",
176+
link: "/guides/utf",
177+
},
178+
],
179+
},
180+
{
181+
text: "Caido Features",
182+
items: [
183+
{
184+
text: "Use Findings",
185+
link: "/guides/findings",
186+
},
187+
{
188+
text: "Use Environment Variables",
189+
link: "/guides/env",
190+
},
191+
],
192+
},
193+
{
194+
text: "Data Storage",
195+
items: [
196+
{
197+
text: "Store Data in SQLite",
198+
link: "/guides/sqlite",
199+
},
200+
{
201+
text: "Add Files",
202+
link: "/guides/files",
203+
},
204+
],
205+
},
206+
{
207+
text: "Events",
208+
items: [
209+
{
210+
text: "Handle Backend Events",
211+
link: "/guides/backend_events",
212+
},
213+
{
214+
text: "Call Custom Functions",
215+
link: "/guides/rpc",
216+
},
217+
{
218+
text: "Send Events to the Frontend",
219+
link: "/guides/events",
220+
},
221+
],
222+
},
223+
{
224+
text: "System Integration",
225+
items: [
226+
{
227+
text: "Spawn a Process",
228+
link: "/guides/spawning_process",
229+
},
230+
],
138231
},
139232
],
140233
},

0 commit comments

Comments
 (0)