Skip to content

Commit f8a24e2

Browse files
initializing the new learn tab
1 parent a8e0f6d commit f8a24e2

File tree

12 files changed

+88
-262
lines changed

12 files changed

+88
-262
lines changed

docs/foundations/core-concepts.md

Lines changed: 0 additions & 80 deletions
This file was deleted.

docs/foundations/harper-architecture.md

Lines changed: 0 additions & 101 deletions
This file was deleted.

docs/foundations/use-cases.md

Lines changed: 0 additions & 80 deletions
This file was deleted.

docusaurus.config.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,17 @@ const config: Config = {
5959
onBrokenMarkdownLinks: 'warn',
6060

6161
plugins: [
62+
// Learn documentation
63+
[
64+
'@docusaurus/plugin-content-docs',
65+
{
66+
id: 'learn',
67+
path: 'learn',
68+
routeBasePath: 'learn',
69+
sidebarPath: './sidebarsLearn.ts',
70+
editUrl: 'https://github.com/HarperDB/documentation/blob/main/',
71+
},
72+
],
6273
// Main documentation
6374
[
6475
'@docusaurus/plugin-content-docs',
@@ -305,6 +316,13 @@ const config: Config = {
305316
href: 'https://www.harper.fast/',
306317
},
307318
items: [
319+
{
320+
type: 'docSidebar',
321+
sidebarId: 'learnSidebar',
322+
docsPluginId: 'learn',
323+
position: 'left',
324+
label: 'Learn',
325+
},
308326
{
309327
type: 'docSidebar',
310328
sidebarId: 'docsSidebar',
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Coming Soon

learn/developers/coming-soon.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Coming Soon
File renamed without changes.
File renamed without changes.

learn/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Welcome to Harper Learn
3+
---
4+
5+
Welcome to Harper Learn!
6+
7+
This section contains thorough guides for learning how to build applications and more with Harper.
8+
9+
Each guide contains all necessary prerequisite and setup instructions for examples.
10+
11+
The guides are presented in a logical order to built up knowledge across Harper's vast features set. Guides can be referenced independently, but will assume the reader is familiar with concepts contained within previous guides. For example, the [Loading Data]() guide assumes the reader already knows how to build a basic Harper application, create databases and tables using schemas, and some basic query techniques. Those concepts are specifically covered throughout the [Getting Started](), [Key Harper Application Features](), and [Defining Databases and Tables]() guides.

sidebarsLearn.ts

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
2+
3+
const sidebarsLearn: SidebarsConfig = {
4+
learnSidebar: [
5+
{
6+
type: 'doc',
7+
id: 'index',
8+
label: 'Welcome',
9+
},
10+
{
11+
type: 'category',
12+
label: 'Getting Started',
13+
collapsible: false,
14+
className: 'learn-category-header',
15+
items: [{ type: 'autogenerated', dirName: 'getting-started' }],
16+
},
17+
{
18+
type: 'category',
19+
label: 'Developers',
20+
collapsible: false,
21+
className: 'learn-category-header',
22+
items: [{ type: 'autogenerated', dirName: 'developers' }],
23+
},
24+
{
25+
type: 'category',
26+
label: 'Administration',
27+
collapsible: false,
28+
className: 'learn-category-header',
29+
items: [{ type: 'autogenerated', dirName: 'administration' }],
30+
},
31+
],
32+
};
33+
34+
export default sidebarsLearn;

0 commit comments

Comments
 (0)