anonpenguin
869049c679
- Created a comprehensive Code Guidelines document outlining coding standards and best practices for DebrosFramework. - Added a Development Setup guide to assist contributors in setting up their environment. - Introduced an Overview document to welcome new contributors and explain the project's status and contribution areas. - Updated the intro.md to reflect the current development status of DebrosFramework. - Modified sidebars.ts to include new contributing documentation in the navigation. - Enhanced package.json description for clarity and added relevant keywords. - Updated version information in DebrosFramework.ts and index.ts to reflect the current beta version.
68 lines
1.4 KiB
TypeScript
68 lines
1.4 KiB
TypeScript
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
|
|
|
|
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
const sidebars: SidebarsConfig = {
|
|
// Main documentation sidebar
|
|
tutorialSidebar: [
|
|
'intro',
|
|
'getting-started',
|
|
{
|
|
type: 'category',
|
|
label: 'Core Concepts',
|
|
items: [
|
|
'core-concepts/architecture',
|
|
'core-concepts/models',
|
|
'core-concepts/decorators',
|
|
],
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: 'Query System',
|
|
items: [
|
|
'query-system/query-builder',
|
|
],
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: 'Examples',
|
|
items: [
|
|
'examples/basic-usage',
|
|
],
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: 'Contributing',
|
|
items: [
|
|
'contributing/overview',
|
|
'contributing/development-setup',
|
|
'contributing/code-guidelines',
|
|
],
|
|
},
|
|
],
|
|
|
|
// API Reference sidebar
|
|
apiSidebar: [
|
|
'api/overview',
|
|
{
|
|
type: 'category',
|
|
label: 'Framework Classes',
|
|
items: [
|
|
'api/debros-framework',
|
|
],
|
|
},
|
|
],
|
|
};
|
|
|
|
export default sidebars;
|