sidebars.js•3.48 kB
/**
* 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: [
// Welcome & Quick Start
{
type: 'doc',
id: 'index',
label: '👋 Welcome',
},
// === DIATAXIS FRAMEWORK ===
// 1. TUTORIALS - Learning-oriented (step-by-step lessons)
{
type: 'category',
label: '🎓 Tutorials',
collapsed: false,
link: {
type: 'doc',
id: 'tutorials/index',
},
items: [
'tutorials/first-steps',
'tutorials/existing-projects',
'tutorials/advanced-analysis',
'tutorials/security-focused-workflow',
'tutorials/team-collaboration',
],
},
// 2. HOW-TO GUIDES - Task-oriented (practical steps)
{
type: 'category',
label: '🛠️ How-To Guides',
collapsed: false,
link: {
type: 'doc',
id: 'how-to/index',
},
items: [
{
type: 'autogenerated',
dirName: 'how-to-guides',
},
],
},
// 3. REFERENCE - Information-oriented (technical description)
{
type: 'category',
label: '📖 Reference',
collapsed: false,
items: [
{
type: 'autogenerated',
dirName: 'reference',
},
],
},
// 4. EXPLANATION - Understanding-oriented (background and context)
{
type: 'category',
label: '💡 Explanation',
collapsed: false,
link: {
type: 'doc',
id: 'explanation/index',
},
items: [
{
type: 'autogenerated',
dirName: 'explanation',
},
],
},
// === ADDITIONAL RESOURCES ===
// Architecture Decision Records
{
type: 'category',
label: '🏗️ Architecture (ADRs)',
collapsed: true,
link: {
type: 'doc',
id: 'adrs/README',
},
items: [
{
type: 'autogenerated',
dirName: 'adrs',
},
],
},
// IDE Integration
{
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: [
'community/CONTRIBUTING',
'how-to-guides/testing-guide',
'how-to-guides/tool-development',
],
},
// Community & Project Info
{
type: 'category',
label: '👥 Community',
collapsed: true,
items: [
{
type: 'autogenerated',
dirName: 'community',
},
],
},
// Research Documentation
{
type: 'category',
label: '🔬 Research',
collapsed: true,
link: {
type: 'doc',
id: 'research/README',
},
items: [
{
type: 'autogenerated',
dirName: 'research',
},
],
},
],
};
module.exports = sidebars;