Skip to content

demo idea: restructure docs into section-based sidebars #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

demo idea: restructure docs into section-based sidebars #261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 10 additions & 18 deletions docusaurus.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,22 +147,14 @@ const config: Config = {
href: 'https://www.harpersystems.dev',
},
items: [
{
type: 'docSidebar',
sidebarId: 'docsSidebar',
position: 'left',
label: 'Documentation',
},
{
type: 'docsVersionDropdown',
position: 'right',
dropdownActiveClassDisabled: true,
},
{
href: 'https://github.com/HarperDB/documentation',
label: 'GitHub',
position: 'right',
},
{ type: 'docSidebar', sidebarId: 'gettingStartedSidebar', label: 'Getting Started', position: 'left', to: `${routeBasePath}getting-started/index` },
{ type: 'docSidebar', sidebarId: 'developersSidebar', label: 'Developers', position: 'left', to: `${routeBasePath}developers/applications/index` },
{ type: 'docSidebar', sidebarId: 'administrationSidebar', label: 'Administration', position: 'left', to: `${routeBasePath}administration/administration` },
{ type: 'docSidebar', sidebarId: 'deploymentsSidebar', label: 'Deployments', position: 'left', to: `${routeBasePath}deployments/install-harper/index` },
{ type: 'docSidebar', sidebarId: 'technicalDetailsSidebar', label: 'Technical Details', position: 'left', to: `${routeBasePath}technical-details/reference/index` },

{ type: 'docsVersionDropdown', position: 'right', dropdownActiveClassDisabled: true },
{ href: 'https://github.com/HarperDB/documentation', label: 'GitHub', position: 'right' }
],
},
footer: {
Expand All @@ -176,8 +168,8 @@ const config: Config = {
to: `${routeBasePath}/getting-started`,
},
// {
// label: 'Developers',
// to: `${routeBasePath}/developers`,
// label: 'Developers',
// to: `${routeBasePath}/developers`,
// },
{
label: 'Administration',
Expand Down
43 changes: 5 additions & 38 deletions sidebars.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,44 +1,11 @@
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';

const sidebars: SidebarsConfig = {
docsSidebar: [
{
type: 'doc',
id: 'index',
label: 'Harper Docs',
},
{
type: 'category',
label: 'Getting Started',
items: [{ type: 'autogenerated', dirName: 'getting-started' }],
},
{
type: 'category',
label: 'Developers',
link: {
type: 'generated-index',
title: 'Developer Documentation',
description: 'Comprehensive guides and references for building applications with HarperDB',
keywords: ['developers', 'api', 'applications'],
},
items: [{ type: 'autogenerated', dirName: 'developers' }],
},
{
type: 'category',
label: 'Administration',
items: [{ type: 'autogenerated', dirName: 'administration' }],
},
{
type: 'category',
label: 'Deployments',
items: [{ type: 'autogenerated', dirName: 'deployments' }],
},
{
type: 'category',
label: 'Technical Details',
items: [{ type: 'autogenerated', dirName: 'technical-details' }],
},
],
gettingStartedSidebar: [{ type: 'autogenerated', dirName: 'getting-started' }],
developersSidebar: [{ type: 'autogenerated', dirName: 'developers' }],
administrationSidebar: [{ type: 'autogenerated', dirName: 'administration' }],
deploymentsSidebar: [{ type: 'autogenerated', dirName: 'deployments' }],
technicalDetailsSidebar:[{ type: 'autogenerated', dirName: 'technical-details' }],
};

export default sidebars;
87 changes: 30 additions & 57 deletions versioned_sidebars/version-4.6-sidebars.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,59 +1,32 @@
{
"docsSidebar": [
{
"type": "doc",
"id": "index",
"label": "Harper Docs"
},
{
"type": "category",
"label": "Getting Started",
"items": [
{
"type": "autogenerated",
"dirName": "getting-started"
}
]
},
{
"type": "category",
"label": "Developers",
"items": [
{
"type": "autogenerated",
"dirName": "developers"
}
]
},
{
"type": "category",
"label": "Administration",
"items": [
{
"type": "autogenerated",
"dirName": "administration"
}
]
},
{
"type": "category",
"label": "Deployments",
"items": [
{
"type": "autogenerated",
"dirName": "deployments"
}
]
},
{
"type": "category",
"label": "Technical Details",
"items": [
{
"type": "autogenerated",
"dirName": "technical-details"
}
]
}
]
"gettingStartedSidebar": [
{
"type": "autogenerated",
"dirName": "getting-started"
}
],
"developersSidebar": [
{
"type": "autogenerated",
"dirName": "developers"
}
],
"administrationSidebar": [
{
"type": "autogenerated",
"dirName": "administration"
}
],
"deploymentsSidebar": [
{
"type": "autogenerated",
"dirName": "deployments"
}
],
"technicalDetailsSidebar": [
{
"type": "autogenerated",
"dirName": "technical-details"
}
]
}