/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
// @ts-check
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
mainSidebar: [
// Getting Started Section
{
type: 'category',
label: '🚀 Getting Started',
collapsed: false,
items: [
'diataxis-index',
'QUICK_START',
'USAGE_GUIDE',
'configuration',
],
},
// Tutorials Section (Diataxis)
{
type: 'category',
label: '🎓 Tutorials',
collapsed: false,
link: {
type: 'doc',
id: 'tutorials/index',
},
items: [
{
type: 'autogenerated',
dirName: 'tutorials',
},
],
},
// How-To Guides Section (Diataxis)
{
type: 'category',
label: '🛠️ How-To Guides',
collapsed: false,
link: {
type: 'doc',
id: 'how-to/index',
},
items: [
{
type: 'autogenerated',
dirName: 'how-to-guides',
},
],
},
// Reference Section (Diataxis)
{
type: 'category',
label: '📖 Reference',
collapsed: false,
items: [
{
type: 'autogenerated',
dirName: 'reference',
},
],
},
// Explanation Section (Diataxis)
{
type: 'category',
label: '💡 Explanation',
collapsed: false,
link: {
type: 'doc',
id: 'explanation/index',
},
items: [
{
type: 'autogenerated',
dirName: 'explanation',
},
],
},
// Architecture & ADRs
{
type: 'category',
label: '🏗️ Architecture',
collapsed: true,
items: [
'architecture-overview',
{
type: 'category',
label: 'ADRs',
link: {
type: 'doc',
id: 'adrs/README',
},
items: [
{
type: 'autogenerated',
dirName: 'adrs',
},
],
},
],
},
// IDE Rules & Workflows
{
type: 'category',
label: '⚙️ IDE Integration',
collapsed: true,
link: {
type: 'doc',
id: 'ide-rules/README',
},
items: [
{
type: 'autogenerated',
dirName: 'ide-rules',
},
],
},
// Development & Contributing
{
type: 'category',
label: '🔧 Development',
collapsed: true,
items: [
'CONTRIBUTING',
'development',
'TESTING_GUIDE',
'MIGRATION_GUIDE',
],
},
// Project Information
{
type: 'category',
label: '📋 Project Info',
collapsed: true,
items: [
'README',
'SECURITY',
'CODE_OF_CONDUCT',
'VERSION_MANAGEMENT',
'release-dashboard',
{
type: 'category',
label: 'Documentation Meta',
collapsed: true,
items: [
'DOCUSAURUS_MIGRATION',
'DOCUSAURUS_QUICKSTART',
'DOCKER_SETUP',
'WEBSITE_SETUP',
'CONVERSION_CHECKLIST',
'DOCUMENTATION_IMPROVEMENT_PLAN',
'DOCUMENTATION-UPDATE-PLAN',
'README_SCRIPTS',
],
},
{
type: 'category',
label: 'Other',
collapsed: true,
items: [
'DEPENDABOT',
'LOGO_DESIGN_PROMPT',
'README-library',
'TODO_MANAGEMENT_FIX',
'getting-started-prd',
'mcp-planning-tool-usage',
'technical',
'troubleshooting',
],
},
],
},
// Research (if needed)
{
type: 'category',
label: '🔬 Research',
collapsed: true,
link: {
type: 'doc',
id: 'research/README',
},
items: [
{
type: 'autogenerated',
dirName: 'research',
},
],
},
],
};
module.exports = sidebars;
