open-navigator / website /sidebars.ts
jcbowyer's picture
Clean HuggingFace deployment without binary files
61d29fc
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
const sidebars: SidebarsConfig = {
// ========================================
// GETTING STARTED - For Everyone
// ========================================
gettingStartedSidebar: [
{
type: 'category',
label: 'Getting Started',
collapsed: false,
items: [
'intro',
'open-navigator',
],
},
{
type: 'doc',
id: 'data-sources/citations',
label: 'Citations & Data Sources',
},
{
type: 'doc',
id: 'legal-compliance',
label: 'Legal & Compliance',
},
],
// ========================================
// FAMILIES & INDIVIDUALS - Community Resources
// ========================================
familiesSidebar: [
{
type: 'category',
label: 'Families & Individuals',
collapsed: false,
items: [
'for-families',
{
type: 'category',
label: 'Resources for Families',
items: [
'families/community-events',
'families/training-education',
'families/voter-registration',
'families/service-requests',
'families/community-resources',
],
},
{
type: 'doc',
id: 'open-navigator',
label: 'Getting Started with Open Navigator',
},
{
type: 'doc',
id: 'data-sources/citations',
label: 'Citations & Data Sources',
},
{
type: 'doc',
id: 'legal-compliance',
label: 'Legal & Compliance',
},
],
},
],
// ========================================
// POLICY MAKERS - Non-Technical
// ========================================
policyMakersSidebar: [
{
type: 'category',
label: 'Policy Makers & Advocates',
collapsed: false,
items: [
'for-advocates',
{
type: 'category',
label: 'Understanding the Data',
items: [
'data-sources/overview',
{
type: 'doc',
id: 'data-sources/citations',
label: 'Citations & Data Sources',
},
'data-sources/nonprofit-sources',
'data-sources/video-sources',
],
},
{
type: 'category',
label: 'Analysis & Strategy',
items: [
'guides/political-economy',
'guides/accountability-strategy',
'guides/impact-navigation',
],
},
{
type: 'category',
label: 'Real-World Examples',
items: [
{
type: 'autogenerated',
dirName: 'case-studies',
},
],
},
],
},
],
// ========================================
// DEVELOPERS - Technical
// ========================================
developersSidebar: [
{
type: 'category',
label: 'Developers & Technical Users',
collapsed: false,
items: [
'for-developers',
{
type: 'category',
label: 'Setup & Installation',
items: [
'quickstart',
'quick-reference',
'architecture',
],
},
{
type: 'category',
label: 'Data Sources (Technical)',
items: [
{
type: 'doc',
id: 'data-sources/citations',
label: 'Citations & Data Sources',
},
{
type: 'doc',
id: 'legal-compliance',
label: 'Legal & Compliance',
},
'data-sources/data-model-erd',
'data-sources/jurisdiction-discovery',
'data-sources/census-data',
// 'data-sources/civic-tech-sources', // Temporarily disabled - MDX parsing issue
'data-sources/huggingface-datasets',
'data-sources/url-datasets',
'data-sources/youtube-discovery',
'data-sources/video-channels',
'data-sources/open-source-repositories',
'data-sources/ballot-election-sources',
'data-sources/polling-survey-sources',
'data-sources/factcheck-sources',
],
},
{
type: 'category',
label: 'How-To Guides',
items: [
'guides/jurisdiction-setup',
'guides/legislative-tracking-maps',
'guides/huggingface-publishing',
'guides/huggingface-quickstart',
'guides/huggingface-features',
'guides/huggingface-limits',
'guides/handling-formats',
'guides/document-libraries',
'guides/scraper-improvements',
'guides/search-patterns',
'guides/split-screen',
],
},
{
type: 'category',
label: 'Integrations',
items: [
{
type: 'autogenerated',
dirName: 'integrations',
},
],
},
{
type: 'category',
label: 'Deployment',
items: [
{
type: 'autogenerated',
dirName: 'deployment',
},
],
},
{
type: 'category',
label: 'Development',
items: [
{
type: 'autogenerated',
dirName: 'development',
},
],
},
],
},
],
// ========================================
// MAIN SIDEBAR - All Documentation
// ========================================
docsSidebar: [
{
type: 'category',
label: 'Getting Started',
collapsed: false,
items: [
'intro',
'open-navigator',
],
},
{
type: 'category',
label: 'Families & Individuals',
collapsed: false,
link: {
type: 'doc',
id: 'for-families',
},
items: [
{
type: 'category',
label: 'Resources for Families',
items: [
'families/community-events',
'families/training-education',
'families/voter-registration',
'families/service-requests',
'families/community-resources',
],
},
{
type: 'doc',
id: 'open-navigator',
label: 'Getting Started with Open Navigator',
},
{
type: 'doc',
id: 'data-sources/citations',
label: 'Citations & Data Sources',
},
],
},
{
type: 'category',
label: 'Policy Makers & Advocates',
collapsed: false,
link: {
type: 'doc',
id: 'for-advocates',
},
items: [
{
type: 'category',
label: 'Understanding the Data',
items: [
'data-sources/overview',
{
type: 'doc',
id: 'data-sources/citations',
label: 'Citations & Data Sources',
},
'data-sources/nonprofit-sources',
'data-sources/video-sources',
],
},
{
type: 'category',
label: 'Analysis & Strategy',
items: [
'guides/political-economy',
'guides/accountability-strategy',
'guides/impact-navigation',
],
},
{
type: 'category',
label: 'Real-World Examples',
items: [
{
type: 'autogenerated',
dirName: 'case-studies',
},
],
},
],
},
{
type: 'category',
label: 'Developers & Technical Users',
collapsed: true,
link: {
type: 'doc',
id: 'for-developers',
},
items: [
{
type: 'category',
label: 'Setup & Installation',
items: [
'quickstart',
'quick-reference',
'architecture',
],
},
{
type: 'category',
label: 'Data Sources (Technical)',
items: [
{
type: 'doc',
id: 'data-sources/citations',
label: 'Citations & Data Sources',
},
{
type: 'doc',
id: 'legal-compliance',
label: 'Legal & Compliance',
},
'data-sources/data-model-erd',
'data-sources/jurisdiction-discovery',
'data-sources/census-data',
'data-sources/huggingface-datasets',
'data-sources/url-datasets',
'data-sources/youtube-discovery',
'data-sources/video-channels',
'data-sources/open-source-repositories',
],
},
{
type: 'category',
label: 'How-To Guides',
items: [
'guides/jurisdiction-setup',
'guides/huggingface-publishing',
'guides/huggingface-quickstart',
'guides/huggingface-features',
'guides/huggingface-limits',
'guides/handling-formats',
'guides/document-libraries',
'guides/scraper-improvements',
'guides/search-patterns',
'guides/split-screen',
],
},
{
type: 'category',
label: 'Integrations',
items: [
{
type: 'autogenerated',
dirName: 'integrations',
},
],
},
{
type: 'category',
label: 'Deployment',
items: [
{
type: 'autogenerated',
dirName: 'deployment',
},
],
},
{
type: 'category',
label: 'Development',
items: [
{
type: 'autogenerated',
dirName: 'development',
},
],
},
],
},
],
// ========================================
// DATA AND TERMS - Standalone Sidebar
// ========================================
citationsSidebar: [
{
type: 'category',
label: 'Data and Terms',
collapsed: false,
items: [
{
type: 'doc',
id: 'data-sources/citations',
label: 'Data and Citations',
},
{
type: 'doc',
id: 'legal/index',
label: 'Terms and Privacy',
},
],
},
],
// ========================================
// LEGAL - Uses same sidebar as Data and Terms
// ========================================
legalSidebar: [
{
type: 'category',
label: 'Data and Terms',
collapsed: false,
items: [
{
type: 'doc',
id: 'data-sources/citations',
label: 'Data and Citations',
},
{
type: 'doc',
id: 'legal/index',
label: 'Terms and Privacy',
},
],
},
],
};
export default sidebars;