mirror of
https://github.com/jpawlowski/hass.tibber_prices.git
synced 2026-03-30 05:13:40 +00:00
d73eda4b2f
- Split documentation into separate User and Developer sites - Migrated existing docs to proper Docusaurus structure - Added custom Tibber-themed header logos (light + dark mode variants) - Implemented custom color scheme matching integration branding - Hero gradient: Cyan → Dark Cyan → Gold - Removed standard Docusaurus purple/green theme - Integrated Giscus comments system for community collaboration - User docs: Comments enabled on guides, examples, FAQ - User docs: Comments disabled on reference pages (glossary, sensors, troubleshooting) - Developer docs: No comments (GitHub Issues/PRs preferred) - Added categorized sidebars with emoji navigation - Created 8 new placeholder documentation pages - Fixed image paths for baseUrl compatibility (local + GitHub Pages) - Escaped MDX special characters in performance metrics - Added GitHub Actions workflow for automated deployment - Created helper scripts: dev-user, dev-developer, build-all Breaking changes: - Moved /docs/user/*.md to /docs/user/docs/*.md - Moved /docs/development/*.md to /docs/developer/docs/*.md
56 lines
1.4 KiB
TypeScript
56 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 = {
|
|
tutorialSidebar: [
|
|
'intro',
|
|
{
|
|
type: 'category',
|
|
label: '🏗️ Architecture',
|
|
items: ['architecture', 'timer-architecture', 'caching-strategy', 'api-reference'],
|
|
collapsible: true,
|
|
collapsed: false,
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: '💻 Development',
|
|
items: ['setup', 'coding-guidelines', 'critical-patterns', 'debugging'],
|
|
collapsible: true,
|
|
collapsed: false,
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: '📐 Advanced Topics',
|
|
items: ['period-calculation-theory', 'refactoring-guide', 'performance'],
|
|
collapsible: true,
|
|
collapsed: false,
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: '📝 Contributing',
|
|
items: ['contributing'],
|
|
collapsible: true,
|
|
collapsed: false,
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: '🚀 Release',
|
|
items: ['release-management', 'testing'],
|
|
collapsible: true,
|
|
collapsed: false,
|
|
},
|
|
],
|
|
};
|
|
|
|
export default sidebars;
|