@@ -3,39 +3,106 @@ import type { DefaultTheme } from 'vitepress';
33// Navigation for the `/docs` section. next.ts is the source of both sidebars;
44// cmd/release copies it over latest.ts alongside the content it describes. See
55// the "Documentation channels" section of website/src/next/docs/contributing.md.
6+ //
7+ // Grouped by what the reader is trying to do: get going, learn Task, look
8+ // something up, follow the project. The DocSearch crawler puts the active
9+ // sidebar section into hierarchy.lvl0, so these labels are also the breadcrumbs
10+ // on every search result.
611export const sidebar : DefaultTheme . SidebarItem [ ] = [
712 {
8- text : 'Installation ' ,
9- link : '/docs/installation '
13+ text : 'Overview ' ,
14+ link : '/docs/'
1015 } ,
1116 {
1217 text : 'Getting Started' ,
13- link : '/docs/getting-started'
18+ items : [
19+ {
20+ text : 'Installation' ,
21+ link : '/docs/installation'
22+ } ,
23+ {
24+ text : 'Quick Start' ,
25+ link : '/docs/getting-started'
26+ } ,
27+ {
28+ text : 'Editors and Integrations' ,
29+ link : '/docs/integrations'
30+ }
31+ ]
1432 } ,
1533 {
1634 text : 'Guide' ,
17- link : '/docs/guide'
18- } ,
19- {
20- text : 'Remote Taskfiles' ,
21- link : '/docs/remote-taskfiles'
35+ link : '/docs/guide/' ,
36+ items : [
37+ {
38+ text : 'Writing and running tasks' ,
39+ collapsed : false ,
40+ items : [
41+ { text : 'Defining tasks' , link : '/docs/guide/defining-tasks' } ,
42+ { text : 'Running tasks' , link : '/docs/guide/running-tasks' }
43+ ]
44+ } ,
45+ {
46+ text : 'Variables and arguments' ,
47+ collapsed : false ,
48+ items : [
49+ { text : 'Variables' , link : '/docs/guide/variables' } ,
50+ { text : 'Command-line arguments' , link : '/docs/guide/arguments' } ,
51+ {
52+ text : 'Validation and prompts' ,
53+ link : '/docs/guide/required-variables'
54+ } ,
55+ { text : 'Secret variables' , link : '/docs/guide/secret-variables' }
56+ ]
57+ } ,
58+ {
59+ text : 'Task execution' ,
60+ collapsed : false ,
61+ items : [
62+ {
63+ text : 'Dependencies and task calls' ,
64+ link : '/docs/guide/dependencies'
65+ } ,
66+ { text : 'Loops' , link : '/docs/guide/loops' } ,
67+ {
68+ text : 'Conditional execution' ,
69+ link : '/docs/guide/conditional-execution'
70+ } ,
71+ {
72+ text : 'Errors and cleanup' ,
73+ link : '/docs/guide/errors-and-cleanup'
74+ } ,
75+ { text : 'Up-to-date checks' , link : '/docs/guide/up-to-date' } ,
76+ { text : 'Watch mode' , link : '/docs/guide/watch' }
77+ ]
78+ } ,
79+ {
80+ text : 'Environment and output' ,
81+ collapsed : false ,
82+ items : [
83+ { text : 'Environment variables' , link : '/docs/guide/environment' } ,
84+ { text : 'Platforms and shells' , link : '/docs/guide/platforms' } ,
85+ { text : 'Output and logging' , link : '/docs/guide/output' }
86+ ]
87+ } ,
88+ {
89+ text : 'Including Taskfiles' ,
90+ collapsed : false ,
91+ items : [
92+ { text : 'Including Taskfiles' , link : '/docs/guide/includes' } ,
93+ { text : 'Remote Taskfiles' , link : '/docs/remote-taskfiles' }
94+ ]
95+ }
96+ ]
2297 } ,
2398 {
2499 text : 'Reference' ,
25- collapsed : true ,
100+ collapsed : false ,
26101 items : [
27102 {
28103 text : 'Taskfile Schema' ,
29104 link : '/docs/reference/schema'
30105 } ,
31- {
32- text : 'Environment' ,
33- link : '/docs/reference/environment'
34- } ,
35- {
36- text : 'Configuration' ,
37- link : '/docs/reference/config'
38- } ,
39106 {
40107 text : 'CLI' ,
41108 link : '/docs/reference/cli'
@@ -44,95 +111,111 @@ export const sidebar: DefaultTheme.SidebarItem[] = [
44111 text : 'Templating' ,
45112 link : '/docs/reference/templating'
46113 } ,
114+ {
115+ text : 'Environment' ,
116+ link : '/docs/reference/environment'
117+ } ,
118+ {
119+ text : 'Configuration' ,
120+ link : '/docs/reference/config'
121+ } ,
47122 {
48123 text : 'Package API' ,
49124 link : '/docs/reference/package'
50125 }
51126 ]
52127 } ,
53128 {
54- text : 'Experiments ' ,
129+ text : 'Project ' ,
55130 collapsed : true ,
56- link : '/docs/experiments/' ,
57131 items : [
58132 {
59- text : 'Env Precedence (#1038) ' ,
60- link : '/docs/experiments/env-precedence '
133+ text : 'Changelog ' ,
134+ link : '/docs/changelog '
61135 } ,
62136 {
63- text : 'Gentle Force (#1200) ' ,
64- link : '/docs/experiments/gentle-force '
137+ text : 'FAQ ' ,
138+ link : '/docs/faq '
65139 } ,
66140 {
67- text : 'Remote Taskfiles (#1317)' ,
68- link : '/docs/experiments/remote-taskfiles'
69- }
70- ]
71- } ,
72- {
73- text : 'Deprecations' ,
74- collapsed : true ,
75- link : '/docs/deprecations/' ,
76- items : [
141+ text : 'Taskfile Versions' ,
142+ link : '/docs/taskfile-versions'
143+ } ,
77144 {
78- text : 'Completion Scripts ' ,
79- link : '/docs/deprecations/completion-scripts '
145+ text : 'Community ' ,
146+ link : '/docs/community '
80147 } ,
81148 {
82- text : 'Template Functions' ,
83- link : '/docs/deprecations/template-functions'
149+ text : 'Experiments' ,
150+ collapsed : true ,
151+ link : '/docs/experiments/' ,
152+ items : [
153+ {
154+ text : 'Env Precedence (#1038)' ,
155+ link : '/docs/experiments/env-precedence'
156+ } ,
157+ {
158+ text : 'Gentle Force (#1200)' ,
159+ link : '/docs/experiments/gentle-force'
160+ } ,
161+ {
162+ text : 'Remote Taskfiles (#1317)' ,
163+ link : '/docs/experiments/remote-taskfiles'
164+ }
165+ ]
84166 } ,
85167 {
86- text : 'Version 2 Schema (#1197)' ,
87- link : '/docs/deprecations/version-2-schema'
168+ text : 'Deprecations' ,
169+ collapsed : true ,
170+ link : '/docs/deprecations/' ,
171+ items : [
172+ {
173+ text : 'Completion Scripts' ,
174+ link : '/docs/deprecations/completion-scripts'
175+ } ,
176+ {
177+ text : 'Template Functions' ,
178+ link : '/docs/deprecations/template-functions'
179+ } ,
180+ {
181+ text : 'Version 2 Schema (#1197)' ,
182+ link : '/docs/deprecations/version-2-schema'
183+ }
184+ ]
185+ } ,
186+ {
187+ text : 'Security' ,
188+ collapsed : true ,
189+ link : '/docs/security/' ,
190+ items : [
191+ {
192+ text : 'Incident Response Plan' ,
193+ link : '/docs/security/incident-response-plan'
194+ } ,
195+ {
196+ text : 'Threat Model' ,
197+ link : '/docs/security/threat-model'
198+ }
199+ ]
88200 }
89201 ]
90202 } ,
91- {
92- text : 'Taskfile Versions' ,
93- link : '/docs/taskfile-versions'
94- } ,
95- {
96- text : 'Integrations' ,
97- link : '/docs/integrations'
98- } ,
99- {
100- text : 'Community' ,
101- link : '/docs/community'
102- } ,
103- {
104- text : 'Style Guide' ,
105- link : '/docs/styleguide'
106- } ,
107203 {
108204 text : 'Contributing' ,
109- link : '/docs/contributing'
110- } ,
111- {
112- text : 'Releasing' ,
113- link : '/docs/releasing'
114- } ,
115- {
116- text : 'Security' ,
117205 collapsed : true ,
118- link : '/docs/security/' ,
119206 items : [
120207 {
121- text : 'Incident Response Plan' ,
122- link : '/docs/security/incident-response-plan'
208+ text : 'Contributing' ,
209+ link : '/docs/contributing'
210+ } ,
211+ {
212+ text : 'Style Guide' ,
213+ link : '/docs/styleguide'
123214 } ,
124215 {
125- text : 'Threat Model ' ,
126- link : '/docs/security/threat-model '
216+ text : 'Releasing ' ,
217+ link : '/docs/releasing '
127218 }
128219 ]
129- } ,
130- {
131- text : 'Changelog' ,
132- link : '/docs/changelog'
133- } ,
134- {
135- text : 'FAQ' ,
136- link : '/docs/faq'
137220 }
138221] ;
0 commit comments