Skip to content

Commit 78ca33b

Browse files
ericgregoryericgregory
committed
fix(docs): restore sidebar reorg
Signed-off-by: Eric Gregory <eric@cosmonic.com>
1 parent 1491d58 commit 78ca33b

File tree

3 files changed

+314
-19
lines changed

3 files changed

+314
-19
lines changed

‎docusaurus.config.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ const config = (async (): Promise<Config> => {
102102
onUntruncatedBlogPosts: 'ignore',
103103
},
104104
docs: {
105+
sidebarPath: require.resolve('./sidebars.js'),
105106
editUrl: 'https://github.com/wasmCloud/wasmcloud.com/edit/main/',
106107
beforeDefaultRehypePlugins: [rehypeShikiPlugin],
107108
rehypePlugins: [rehypeNameToId],

‎sidebars.js‎

Lines changed: 153 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,165 @@
1-
/**
2-
* Creating a sidebar enables you to:
3-
- create an ordered group of docs
4-
- render a sidebar for each doc of that group
5-
- provide next/previous navigation
6-
7-
The sidebars can be generated from the filesystem, or explicitly defined here.
8-
9-
Create as many sidebars as you want.
10-
*/
11-
121
// @ts-check
132

143
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
154
const sidebars = {
16-
// By default, Docusaurus generates a sidebar from the docs folder structure
17-
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
18-
19-
// But you can create a sidebar manually
20-
/*
215
tutorialSidebar: [
6+
{
7+
type: 'html',
8+
value: 'Get Started',
9+
className: 'sidebar-section-header',
10+
},
11+
'index',
12+
'installation',
13+
{
14+
type: 'category',
15+
label: 'Quickstart',
16+
link: { type: 'doc', id: 'quickstart/index' },
17+
items: [
18+
'quickstart/develop-a-webassembly-component',
19+
'quickstart/deploy-a-webassembly-workload',
20+
],
21+
},
22+
23+
{
24+
type: 'html',
25+
value: 'Platform',
26+
className: 'sidebar-section-header',
27+
},
28+
{
29+
type: 'category',
30+
label: 'Overview',
31+
link: { type: 'doc', id: 'overview/index' },
32+
items: [
33+
{
34+
type: 'category',
35+
label: 'Workloads',
36+
link: { type: 'doc', id: 'overview/workloads/index' },
37+
items: [
38+
'overview/workloads/components',
39+
'overview/workloads/services',
40+
],
41+
},
42+
{
43+
type: 'category',
44+
label: 'Hosts',
45+
link: { type: 'doc', id: 'overview/hosts/index' },
46+
items: [
47+
'overview/hosts/plugins',
48+
],
49+
},
50+
'overview/interfaces',
51+
'overview/transport',
52+
'overview/packaging',
53+
],
54+
},
55+
{
56+
type: 'category',
57+
label: 'Wasm Shell (wash) CLI',
58+
link: { type: 'doc', id: 'wash/index' },
59+
items: [
60+
'wash/commands',
61+
'wash/config',
62+
'wash/registries',
63+
'wash/faq',
64+
],
65+
},
66+
{
67+
type: 'category',
68+
label: 'Runtime',
69+
link: { type: 'doc', id: 'runtime/index' },
70+
items: [
71+
'runtime/creating-host-plugins',
72+
'runtime/building-custom-hosts',
73+
'runtime/washlet',
74+
],
75+
},
76+
{
77+
type: 'category',
78+
label: 'Kubernetes Operator',
79+
link: { type: 'doc', id: 'kubernetes-operator/index' },
80+
items: [
81+
{
82+
type: 'category',
83+
label: 'Operator Manual',
84+
items: [
85+
'kubernetes-operator/operator-manual/overview',
86+
'kubernetes-operator/operator-manual/cicd',
87+
'kubernetes-operator/operator-manual/roles-and-rolebindings',
88+
'kubernetes-operator/operator-manual/private-registries',
89+
'kubernetes-operator/operator-manual/filesystems-and-volumes',
90+
'kubernetes-operator/operator-manual/lightweight-deployments',
91+
],
92+
},
93+
'kubernetes-operator/crds',
94+
'kubernetes-operator/api-reference',
95+
],
96+
},
97+
98+
{
99+
type: 'html',
100+
value: 'Developer Guide',
101+
className: 'sidebar-section-header',
102+
},
103+
{
104+
type: 'doc',
105+
id: 'wash/developer-guide/index',
106+
label: 'Introduction',
107+
},
108+
'wash/developer-guide/build-and-publish',
109+
'wash/developer-guide/create-services',
110+
{
111+
type: 'category',
112+
label: 'Language Support',
113+
link: { type: 'doc', id: 'wash/developer-guide/language-support/index' },
114+
items: [
115+
'wash/developer-guide/language-support/rust/index',
116+
{
117+
type: 'category',
118+
label: 'TypeScript Language Guide',
119+
link: { type: 'doc', id: 'wash/developer-guide/language-support/typescript/index' },
120+
items: [
121+
'wash/developer-guide/language-support/typescript/key-value-storage',
122+
'wash/developer-guide/language-support/typescript/blob-storage',
123+
],
124+
},
125+
'wash/developer-guide/language-support/go/index',
126+
],
127+
},
128+
'examples',
129+
'wash/developer-guide/network-access-and-socket-isolation',
130+
'wash/developer-guide/debugging-components',
131+
'wash/developer-guide/useful-webassembly-tools',
132+
133+
{
134+
type: 'html',
135+
value: 'Reference',
136+
className: 'sidebar-section-header',
137+
},
138+
'glossary',
139+
'faq',
140+
'migration',
141+
142+
{
143+
type: 'html',
144+
value: 'Community',
145+
className: 'sidebar-section-header',
146+
},
147+
'governance',
22148
{
23149
type: 'category',
24-
label: 'Tutorial',
25-
items: ['hello'],
150+
label: 'Contributing',
151+
link: { type: 'doc', id: 'contributing/index' },
152+
items: [
153+
'contributing/contributing-guide',
154+
'contributing/documentation',
155+
],
156+
},
157+
{
158+
type: 'link',
159+
label: 'Roadmap ↗',
160+
href: 'https://github.com/orgs/wasmCloud/projects/7',
26161
},
27162
],
28-
*/
29163
};
30164

31165
module.exports = sidebars;

‎versioned_sidebars/version-next-sidebars.json‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
{
2+
"defaultSidebar": [
3+
{
4+
"type": "html",
5+
"value": "Get Started",
6+
"className": "sidebar-section-header"
7+
},
8+
"index",
9+
"installation",
10+
{
11+
"type": "category",
12+
"label": "Quickstart",
13+
"link": { "type": "doc", "id": "quickstart/index" },
14+
"items": [
15+
"quickstart/develop-a-webassembly-component",
16+
"quickstart/deploy-a-webassembly-workload"
17+
]
18+
},
19+
20+
{
21+
"type": "html",
22+
"value": "Platform",
23+
"className": "sidebar-section-header"
24+
},
25+
{
26+
"type": "category",
27+
"label": "Overview",
28+
"link": { "type": "doc", "id": "overview/index" },
29+
"items": [
30+
{
31+
"type": "category",
32+
"label": "Workloads",
33+
"link": { "type": "doc", "id": "overview/workloads/index" },
34+
"items": [
35+
"overview/workloads/components",
36+
"overview/workloads/services"
37+
]
38+
},
39+
{
40+
"type": "category",
41+
"label": "Hosts",
42+
"link": { "type": "doc", "id": "overview/hosts/index" },
43+
"items": [
44+
"overview/hosts/plugins"
45+
]
46+
},
47+
"overview/interfaces",
48+
"overview/transport",
49+
"overview/packaging"
50+
]
51+
},
52+
{
53+
"type": "category",
54+
"label": "Wasm Shell (wash) CLI",
55+
"link": { "type": "doc", "id": "wash/index" },
56+
"items": [
57+
"wash/commands",
58+
"wash/config",
59+
"wash/registries",
60+
"wash/faq"
61+
]
62+
},
63+
{
64+
"type": "category",
65+
"label": "Runtime",
66+
"link": { "type": "doc", "id": "runtime/index" },
67+
"items": [
68+
"runtime/creating-host-plugins",
69+
"runtime/building-custom-hosts",
70+
"runtime/washlet"
71+
]
72+
},
73+
{
74+
"type": "category",
75+
"label": "Kubernetes Operator",
76+
"link": { "type": "doc", "id": "kubernetes-operator/index" },
77+
"items": [
78+
{
79+
"type": "category",
80+
"label": "Operator Manual",
81+
"items": [
82+
"kubernetes-operator/operator-manual/overview",
83+
"kubernetes-operator/operator-manual/cicd",
84+
"kubernetes-operator/operator-manual/roles-and-rolebindings",
85+
"kubernetes-operator/operator-manual/private-registries",
86+
"kubernetes-operator/operator-manual/filesystems-and-volumes",
87+
"kubernetes-operator/operator-manual/lightweight-deployments"
88+
]
89+
},
90+
"kubernetes-operator/crds",
91+
"kubernetes-operator/api-reference"
92+
]
93+
},
94+
95+
{
96+
"type": "html",
97+
"value": "Developer Guide",
98+
"className": "sidebar-section-header"
99+
},
100+
{
101+
"type": "doc",
102+
"id": "wash/developer-guide/index",
103+
"label": "Introduction"
104+
},
105+
"wash/developer-guide/build-and-publish",
106+
"wash/developer-guide/create-services",
107+
{
108+
"type": "category",
109+
"label": "Language Support",
110+
"link": { "type": "doc", "id": "wash/developer-guide/language-support/index" },
111+
"items": [
112+
"wash/developer-guide/language-support/rust/index",
113+
{
114+
"type": "category",
115+
"label": "TypeScript Language Guide",
116+
"link": { "type": "doc", "id": "wash/developer-guide/language-support/typescript/index" },
117+
"items": [
118+
"wash/developer-guide/language-support/typescript/key-value-storage",
119+
"wash/developer-guide/language-support/typescript/blob-storage"
120+
]
121+
},
122+
"wash/developer-guide/language-support/go/index"
123+
]
124+
},
125+
"examples",
126+
"wash/developer-guide/network-access-and-socket-isolation",
127+
"wash/developer-guide/debugging-components",
128+
"wash/developer-guide/useful-webassembly-tools",
129+
130+
{
131+
"type": "html",
132+
"value": "Reference",
133+
"className": "sidebar-section-header"
134+
},
135+
"glossary",
136+
"faq",
137+
"migration",
138+
139+
{
140+
"type": "html",
141+
"value": "Community",
142+
"className": "sidebar-section-header"
143+
},
144+
"governance",
145+
{
146+
"type": "category",
147+
"label": "Contributing",
148+
"link": { "type": "doc", "id": "contributing/index" },
149+
"items": [
150+
"contributing/contributing-guide",
151+
"contributing/documentation"
152+
]
153+
},
154+
{
155+
"type": "link",
156+
"label": "Roadmap ↗",
157+
"href": "https://github.com/orgs/wasmCloud/projects/7"
158+
}
159+
]
160+
}

0 commit comments

Comments
 (0)