# section URL: /api/orchestration/section/ Section: orchestration -------------------------------------------------------------------------------- section - Bengal window.BENGAL_THEME_DEFAULTS = { appearance: 'dark', palette: 'snow-lynx' }; // Progressive Enhancement System Configuration window.Bengal = window.Bengal || {}; window.Bengal.enhanceBaseUrl = '/bengal/assets/js/enhancements'; window.Bengal.watchDom = true; window.Bengal.debug = false; (function () { try { var defaults = window.BENGAL_THEME_DEFAULTS || { appearance: 'system', palette: '' }; var defaultAppearance = defaults.appearance; if (defaultAppearance === 'system') { defaultAppearance = (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'; } var storedTheme = localStorage.getItem('bengal-theme'); var storedPalette = localStorage.getItem('bengal-palette'); var theme = storedTheme ? (storedTheme === 'system' ? defaultAppearance : storedTheme) : defaultAppearance; var palette = storedPalette ?? defaults.palette; document.documentElement.setAttribute('data-theme', theme); if (palette) { document.documentElement.setAttribute('data-palette', palette); } } catch (e) { document.documentElement.setAttribute('data-theme', 'light'); } })(); Skip to main content Magnifying Glass ESC Recent Clear Magnifying Glass No results for "" Try different keywords or check your spelling Start typing to search... ↑↓ Navigate ↵ Open ESC Close Powered by Lunr ᓚᘏᗢ Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Magnifying Glass Search ⌘K Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal List ᓚᘏᗢ Magnifying Glass Search X Close Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal API Reference __main__ bengal Caret Right Folder Analysis community_detection graph_analysis graph_reporting graph_visualizer knowledge_graph link_suggestions link_types page_rank path_analysis performance_advisor results Caret Right Folder Assets manifest pipeline Caret Right Folder Autodoc base config docstring_parser utils virtual_orchestrator Caret Right Folder Extractors cli openapi python Caret Right Folder Models cli common openapi python Caret Right Folder Cache asset_dependency_map cache_store cacheable compression dependency_tracker page_discovery_cache query_index query_index_registry taxonomy_index utils Caret Right Folder Build Cache autodoc_tracking core file_tracking fingerprint parsed_content_cache rendered_output_cache taxonomy_index_mixin validation_cache Caret Right Folder Indexes author_index category_index date_range_index section_index Caret Right Folder Cli __main__ base site_templates utils Caret Right Folder Commands assets build clean collections config debug explain fix health init perf project serve site skeleton sources theme utils validate Caret Right Folder Graph __main__ bridges communities orphans pagerank report suggest Caret Right Folder New config presets scaffolds site wizard Caret Right Folder Helpers cli_app_loader cli_output config_validation error_handling menu_config metadata progress site_loader traceback validation Caret Right Folder Skeleton hydrator schema Caret Right Folder Templates base registry Caret Right Folder Blog template Caret Right Folder Changelog template Caret Right Folder Default template Caret Right Folder Docs template Caret Right Folder Landing template Caret Right Folder Portfolio template Caret Right Folder Resume template Caret Right Folder Collections errors loader schemas validator Caret Right Folder Config defaults deprecation directory_loader env_overrides environment feature_mappings hash loader merge origin_tracker validators Caret Right Folder Content Layer entry loaders manager source Caret Right Folder Sources github local notion rest Caret Right Folder Content Types base registry strategies Caret Right Folder Core build_context cascade_engine menu section theme Caret Right Folder Asset asset_core css_transforms Caret Right Folder Page computed content metadata navigation operations page_core proxy relationships utils Caret Right Folder Site core data discovery factories page_caches properties section_registry theme Caret Right Folder Debug base config_inspector content_migrator delta_analyzer dependency_visualizer explainer incremental_debugger models reporter shortcode_sandbox Caret Right Folder Discovery asset_discovery content_discovery Caret Right Folder Fonts downloader generator Caret Right Folder Health autofix base health_check report Caret Right Folder Linkcheck async_checker ignore_policy internal_checker models orchestrator Caret Right Folder Validators anchors assets cache config connectivity cross_ref fonts links menu navigation output performance rendering rss sitemap taxonomy tracks Caret Right Folder Directives analysis checkers constants Caret Right Folder Orchestration asset content full_to_incremental incremental menu postprocess related_posts render section static streaming taxonomy Caret Right Folder Postprocess html_output redirects rss sitemap special_pages Caret Right Folder Output Formats index_generator json_generator llm_generator lunr_index_generator txt_generator utils Caret Right Folder Rendering api_doc_enhancer asset_extractor errors jinja_utils link_transformer link_validator pygments_cache renderer template_context template_profiler validator Caret Right Folder Parsers base factory mistune native_html pygments_patch python_markdown Caret Right Folder Pipeline core output thread_local toc transforms Caret Right Folder Plugins badges cross_references inline_icon term variable_substitution Caret Right Folder Directives _icons admonitions badge base button cache cards checklist code_tabs container contracts data_table dropdown embed errors example_label fenced figure glossary icon include list_table literalinclude marimo navigation options rubric steps tabs target term terminal tokens utils validator video Caret Right Folder Template Engine asset_url core environment manifest menu url_helpers Caret Right Folder Template Functions advanced_collections advanced_strings autodoc collections content crossref data dates debug files get_page i18n icons images math_functions navigation pagination_helpers seo strings tables taxonomies theme urls Caret Right Folder Server build_handler component_preview constants dev_server live_reload pid_manager reload_controller request_handler request_logger resource_manager utils Caret Right Folder Services validation Caret Right Folder Themes config Caret Right Folder Utils atomic_write autodoc build_context build_stats build_summary cli_output css_minifier dates dotdict error_handlers file_io file_lock hashing incremental_constants js_bundler live_progress logger metadata observability page_initializer pagination path_resolver paths performance_collector performance_report profile progress retry rich_console sections swizzle text theme_registry theme_resolution thread_local traceback_config traceback_renderer url_normalization url_strategy API Reference Orchestration ᗢ Caret Down Link Copy URL External Open LLM text Copy Copy LLM text Share with AI Ask Claude Ask ChatGPT Ask Gemini Ask Copilot Module orchestration.section Section orchestration for Bengal SSG. Handles section lifecycle: ensuring all sections have index pages, validation, and structural integrity. View source 1 Class Classes SectionOrchestrator Handles section structure and completeness. Responsibilities: - Ensure all sections have index pag… 13 Caret Right Handles section structure and completeness. Responsibilities: Ensure all sections have index pages (explicit or auto-generated) Generate archive pages for sections without _index.md Validate section structure Maintain section hierarchy integrity This orchestrator implements the "structural" concerns of sections, separate from cross-cutting concerns like taxonomies (tags, categories). Methods 2 finalize_sections Finalize sections by ensuring they have index pages. For each section: - If it… 1 None Caret Right def finalize_sections(self, affected_sections: set[str] | None = None) -> None Finalize sections by ensuring they have index pages. For each section: If it has an explicit _index.md, leave it alone If it doesn't have an index page, generate an archive page Recursively process subsections This ensures all section URLs resolve to valid pages. Parameters 1 affected_sections set[str] | None Set of section paths that were affected by changes. If None, finalize all sections (full build). If provided, only finalize affected sections (incremental). validate_sections Validate that all sections have valid index pages. 0 list[str] Caret Right def validate_sections(self) -> list[str] Validate that all sections have valid index pages. Returns list[str] — List of validation error messages (empty if all valid) Internal Methods 11 Caret Right __init__ Initialize section orchestrator. 1 None Caret Right def __init__(self, site: Site) Initialize section orchestrator. Parameters 1 site Site Site instance to manage sections for _finalize_recursive_filtered Recursively finalize only affected sections (incremental optimization). 2 int Caret Right def _finalize_recursive_filtered(self, section: Section, affected_sections: set[str]) -> int Recursively finalize only affected sections (incremental optimization). Parameters 2 section Section Section to finalize affected_sections set[str] Set of section paths that were affected Returns int — Number of archive pages created _needs_finalization Check if a section or any of its subsections needs finalization. A section nee… 1 bool Caret Right def _needs_finalization(self, section: Section) -> bool Check if a section or any of its subsections needs finalization. A section needs finalization if it or any subsection lacks an index page. This is used to ensure sections are finalized even in incremental builds. Parameters 1 section Section Section to check Returns bool — True if section or any subsection lacks an index page _finalize_recursive Recursively finalize a section and its subsections. 1 int Caret Right def _finalize_recursive(self, section: Section) -> int Recursively finalize a section and its subsections. Parameters 1 section Section Section to finalize Returns int — Number of archive pages created _detect_content_type Detect what kind of content this section contains. Delegates to the content ty… 1 str Caret Right def _detect_content_type(self, section: Section) -> str Detect what kind of content this section contains. Delegates to the content type registry's detection logic. Respects site-level default_content_type configuration. Parameters 1 section Section Section to analyze Returns str — Content type name (e.g., 'blog', 'doc', 'api-reference') _should_paginate Determine if section should have pagination. Delegates to the content type str… 2 bool Caret Right def _should_paginate(self, section: Section, content_type: str) -> bool Determine if section should have pagination. Delegates to the content type strategy's pagination logic. Parameters 2 section Section Section to check content_type str Detected content type Returns bool — True if section should have pagination _get_template_for_content_type Get the appropriate template for a content type. Delegates to the content type… 1 str Caret Right def _get_template_for_content_type(self, content_type: str) -> str Get the appropriate template for a content type. Delegates to the content type strategy's template logic. Parameters 1 content_type str Type of content Returns str — Template name _prepare_posts_list Prepare the posts list for a section using content type strategy. 2 list[Page] Caret Right def _prepare_posts_list(self, section: Section, content_type: str) -> list[Page] Prepare the posts list for a section using content type strategy. Parameters 2 section Section Section to prepare posts for content_type str Content type of the section Returns list[Page] — Filtered and sorted list of pages _create_archive_index Create an auto-generated index page for a section. Detects content type and us… 1 Page Caret Right def _create_archive_index(self, section: Section) -> Page Create an auto-generated index page for a section. Detects content type and uses appropriate template: API reference docs: api-reference/list.html (no pagination) CLI reference docs: cli-reference/list.html (no pagination) Tutorial sections: tutorial/list.html (no pagination) Blog/chronological: archive.html (with pagination) Generic sections: index.html (fallback) Parameters 1 section Section Section that needs an index page Returns Page — Page object representing the section index _enrich_existing_index Enrich an existing user-created index page with section context. This adds the… 1 None Caret Right def _enrich_existing_index(self, section: Section) -> None Enrich an existing user-created index page with section context. This adds the same metadata that auto-generated archives get, allowing user-created index pages with type: blog or archive to work properly. Parameters 1 section Section Section with an existing index page _validate_recursive Recursively validate a section and its subsections. 1 list[str] Caret Right def _validate_recursive(self, section: Section) -> list[str] Recursively validate a section and its subsections. Parameters 1 section Section Section to validate Returns list[str] — List of validation error messages ← Previous render Next → static List © 2025 Bengal ᓚᘏᗢ window.BENGAL_LAZY_ASSETS = { tabulator: '/bengal/assets/js/tabulator.min.js', dataTable: '/bengal/assets/js/data-table.js', mermaidToolbar: '/bengal/assets/js/mermaid-toolbar.9de5abba.js', mermaidTheme: '/bengal/assets/js/mermaid-theme.344822c5.js', graphMinimap: '/bengal/assets/js/graph-minimap.cc7e42e3.js', graphContextual: '/bengal/assets/js/graph-contextual.440e59c6.js' }; window.BENGAL_ICONS = { close: '/bengal/assets/icons/close.911d4fe1.svg', enlarge: '/bengal/assets/icons/enlarge.652035e5.svg', copy: '/bengal/assets/icons/copy.3d56e945.svg', 'download-svg': '/bengal/assets/icons/download.04f07e1b.svg', 'download-png': '/bengal/assets/icons/image.c34dfd40.svg', 'zoom-in': '/bengal/assets/icons/zoom-in.237b4a83.svg', 'zoom-out': '/bengal/assets/icons/zoom-out.38857c77.svg', reset: '/bengal/assets/icons/reset.d26dba29.svg' }; Arrow Up X -------------------------------------------------------------------------------- Metadata: - Author: lbliii - Word Count: 1766 - Reading Time: 9 minutes