Skip to content

Commit 4309cfa

Browse files
committed
feat(sidebars): add architecture sidebar for improved navigation
1 parent 1feaacc commit 4309cfa

File tree

4 files changed

+95
-38
lines changed

4 files changed

+95
-38
lines changed

docs/architecture/overview.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
id: overview
3+
title: Architecture Overview
4+
sidebar_label: Overview
5+
---
6+
7+
# AutoDev Architecture
8+
9+
This page describes the high-level architecture of the AutoDev system.
10+
11+
## Core Components
12+
13+
Add your architecture documentation here.
14+
15+
## System Design
16+
17+
Explain your system design principles here.
18+
19+
## Integration Points
20+
21+
Describe how AutoDev integrates with other systems.

docusaurus.config.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,12 @@ const config = {
8181
label: 'Blog',
8282
position: 'left',
8383
},
84+
{
85+
type: 'docSidebar',
86+
sidebarId: 'architectureSidebar',
87+
position: 'left',
88+
label: 'Architecture',
89+
},
8490
{
8591
type: 'localeDropdown',
8692
position: 'right',
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
id: overview
3+
title: Architecture Overview
4+
sidebar_label: Overview
5+
---
6+
7+
# AutoDev Architecture Overview
8+
9+
This page describes the high-level architecture of the AutoDev system.
10+
11+
## Core Components
12+
13+
Add your architecture documentation here.
14+
15+
## System Design
16+
17+
Explain your system design principles here.
18+
19+
## Integration Points
20+
21+
Describe how AutoDev integrates with other systems.

sidebars.js

Lines changed: 47 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -88,48 +88,48 @@ const sidebars = {
8888
],
8989
},
9090
{
91-
type: 'category',
92-
label: 'Scenes',
93-
items: [
94-
'scenes/domain-driven-design',
95-
'scenes/harmony-os',
96-
'scenes/legacy-migration',
97-
'scenes/scenes',
98-
'scenes/tdd',
99-
'scenes/tech-writing',
100-
],
91+
type: 'category',
92+
label: 'Scenes',
93+
items: [
94+
'scenes/domain-driven-design',
95+
'scenes/harmony-os',
96+
'scenes/legacy-migration',
97+
'scenes/scenes',
98+
'scenes/tdd',
99+
'scenes/tech-writing',
100+
],
101101
},
102102
{
103-
type: 'category',
104-
label: 'Workflow',
105-
items: [
106-
'workflow/auto-page',
107-
'workflow/auto-sql',
108-
'workflow/auto-test',
109-
'workflow/workflow',
110-
],
103+
type: 'category',
104+
label: 'Workflow',
105+
items: [
106+
'workflow/auto-page',
107+
'workflow/auto-sql',
108+
'workflow/auto-test',
109+
'workflow/workflow',
110+
],
111111
},
112112
{
113-
type: 'category',
114-
label: 'Development',
115-
items: [
116-
'development/agentic-testcase',
117-
'development/code-review-prompting',
118-
'development/compatible-strategy',
119-
'development/custom-language',
120-
'development/debug-new-language',
121-
'development/dev-new-language',
122-
'development/development',
123-
'development/development-faq',
124-
'development/git-commit-prompting',
125-
'development/prompt-strategy',
126-
'development/refactoring-prompt',
127-
'development/patterns/patterns',
128-
'development/patterns/executable-unit-validation',
129-
'development/patterns/by-example',
130-
'development/patterns/task-driven',
131-
'development/patterns/unit-driven',
132-
],
113+
type: 'category',
114+
label: 'Development',
115+
items: [
116+
'development/agentic-testcase',
117+
'development/code-review-prompting',
118+
'development/compatible-strategy',
119+
'development/custom-language',
120+
'development/debug-new-language',
121+
'development/dev-new-language',
122+
'development/development',
123+
'development/development-faq',
124+
'development/git-commit-prompting',
125+
'development/prompt-strategy',
126+
'development/refactoring-prompt',
127+
'development/patterns/patterns',
128+
'development/patterns/executable-unit-validation',
129+
'development/patterns/by-example',
130+
'development/patterns/task-driven',
131+
'development/patterns/unit-driven',
132+
],
133133
},
134134
'troubleshooting',
135135
{
@@ -140,6 +140,15 @@ const sidebars = {
140140
],
141141
},
142142
],
143+
architectureSidebar: [
144+
{
145+
type: 'category',
146+
label: 'Architecture',
147+
items: [
148+
'architecture/overview',
149+
],
150+
}
151+
],
143152
}
144153

145154
export default sidebars

0 commit comments

Comments
 (0)