Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit d833603

Browse files
committedApr 17, 2025·
hello guides
1 parent d146df9 commit d833603

File tree

6 files changed

+91
-5
lines changed

6 files changed

+91
-5
lines changed
 

‎website/docusaurus.config.ts

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,10 @@ const config: Config = {
4545
{
4646
docs: {
4747
sidebarPath: './sidebars.ts',
48-
// Please change this to your repo.
49-
// Remove this to remove the "edit this page" links.
5048
editUrl: `${vars.github}edit/main/website/`,
5149
},
5250
blog: {
5351
showReadingTime: true,
54-
// Please change this to your repo.
55-
// Remove this to remove the "edit this page" links.
5652
editUrl: `${vars.github}edit/main/website/`,
5753
},
5854
theme: {
@@ -87,6 +83,11 @@ const config: Config = {
8783
position: 'left',
8884
label: 'Documentation',
8985
},
86+
{
87+
to: '/guides/',
88+
label: 'Guides',
89+
position: 'left',
90+
},
9091
{ to: '/playground', label: 'Playground', position: 'left' },
9192
{ to: '/services', label: 'Services', position: 'left' },
9293
{ to: '/blog', label: 'Blog', position: 'left' },
@@ -175,7 +176,21 @@ const config: Config = {
175176
},
176177
} satisfies Preset.ThemeConfig,
177178

178-
plugins: [tailwindPlugin],
179+
plugins: [
180+
tailwindPlugin,
181+
[
182+
'@docusaurus/plugin-content-docs',
183+
{
184+
id: 'guides',
185+
path: './guides',
186+
routeBasePath: '/guides/',
187+
sidebarPath: './guides/sidebars.ts',
188+
editUrl: `${vars.github}edit/main/website/`,
189+
include: ['**/*.{md,mdx}'],
190+
exclude: ['**/_*.{js,jsx,ts,tsx,md,mdx}'],
191+
},
192+
],
193+
],
179194
};
180195

181196
async function tailwindPlugin() {

‎website/guides/getting-started.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
sidebar_position: 1
3+
title: Getting lol
4+
description: bla bla bla
5+
---
6+
7+
# Getting Started with walkerOS
8+
9+
This guide will help you get started with walkerOS, our open-source event data
10+
collection platform.
11+
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"position": 1,
3+
"label": "Implementations",
4+
"description": "Implementations of walkerOS"
5+
}
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
sidebar_position: 2
3+
title: No description
4+
---
5+
6+
# Tracking Events with walkerOS
7+
8+
How to track events with walkerOS.

‎website/guides/index.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
sidebar_position: 0
3+
title: Overview
4+
---
5+
6+
# Guides
7+
8+
Welcome to the walkerOS guides! Here you'll find step-by-step tutorials and
9+
practical examples to help you get started with walkerOS.
10+
11+
## Available Guides
12+
13+
14+
15+
import DocCardList from '@theme/DocCardList';
16+
17+
<DocCardList />
18+
19+
## What's Next?
20+
21+
- Check out our [documentation](../docs) for detailed API references
22+
- Visit the [playground](../playground) to try out walkerOS in your browser
23+
- Join our [community](https://github.com/elbwalker/walkerOS/discussions) to ask
24+
questions and share your experiences

‎website/guides/sidebars.ts

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
2+
3+
const sidebars: SidebarsConfig = {
4+
guidesSidebar: [
5+
{
6+
type: 'category',
7+
label: 'Guides',
8+
link: {
9+
type: 'generated-index',
10+
title: 'Guides Overview',
11+
description: 'Learn how to use walkerOS with our comprehensive guides',
12+
},
13+
items: [
14+
{
15+
type: 'autogenerated',
16+
dirName: '.',
17+
},
18+
],
19+
},
20+
],
21+
};
22+
23+
export default sidebars;

0 commit comments

Comments
 (0)
Please sign in to comment.