developers.home-assistant/sidebars.js

/**
 * Copyright (c) 2017-present, Facebook, Inc.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

module.exports = {
  API: [
    "api/rest",
    "api/websocket",
    "api/server-sent-events",
    {
      type: "category",
      label: "Native App Integration",
      items: [
        "api/native-app-integration",
        "api/native-app-integration/setup",
        "api/native-app-integration/sending-data",
        "api/native-app-integration/sensors",
        "api/native-app-integration/notifications",
        "api/native-app-integration/webview",
      ],
    },
  ],
  Architecture: {
    Architecture: [
      "architecture_index",
      "architecture_components",
      "architecture_entities",
      "architecture_hassio",
    ],
    Entities: [
      "entity_index",
      "entity_air_quality",
      "entity_alarm_control_panel",
      "entity_binary_sensor",
      "entity_climate",
      "entity_cover",
      "entity_fan",
      "entity_light",
      "entity_lock",
      "entity_media_player",
      "entity_remote",
      "entity_sensor",
      "entity_switch",
      "entity_vacuum",
      "entity_water_heater",
      "entity_weather",
    ],
    Authentication: [
      "auth_index",
      "auth_permissions",
      "auth_api",
      "auth_auth_provider",
      "auth_auth_module",
    ],
    "Config Entries": ["config_entries_index"],
    "Data Entry Flow": ["data_entry_flow_index"],
    "Entity Registry": ["entity_registry_index", "entity_registry_disabled_by"],
    "Device Registry": ["device_registry_index"],
    "Area Registry": ["area_registry_index"],
  },
  "Extending Frontend": {
    Frontend: [
      "frontend_index",
      "frontend_architecture",
      "frontend_development",
      "frontend_data",
      "frontend_external_auth",
      "frontend_external_bus",
    ],
    "Extending the frontend": [
      "frontend_add_card",
      "frontend_add_more_info",
      "frontend_add_websocket_api",
    ],
    "Custom UI": ["lovelace_custom_card", "frontend_creating_custom_panels"],
  },
  "Extending Home Assistant": {
    "Development Workflow": [
      "development_index",
      "development_environment",
      "development_submitting",
      "development_guidelines",
      "development_testing",
      "development_catching_up",
    ],
    "Building Integrations": [
      "creating_integration_file_structure",
      "creating_integration_manifest",
      "creating_component_index",
      "config_entries_config_flow_handler",
      "config_entries_options_flow_handler",
      "configuration_yaml_index",
      "dev_101_services",
      "creating_platform_index",
      "creating_component_generic_discovery",
      "reproduce_state_index",
      "integration_fetching_data",
    ],
    "Development Checklist": [
      "development_checklist",
      "creating_component_code_review",
      "creating_platform_code_review",
      "integration_quality_scale_index",
    ],
    "Home Assistant Core 101": [
      "dev_101_index",
      "dev_101_hass",
      "dev_101_events",
      "dev_101_states",
      "dev_101_config",
    ],
    "Device Automations": [
      "device_automation_index",
      "device_automation_trigger",
      "device_automation_condition",
      "device_automation_action",
    ],
    Misc: ["development_validation", "development_typing", "instance_url"],
  },
  Misc: {
    Introduction: ["misc"],
    Internationalization: [
      "internationalization_index",
      "internationalization_backend_localization",
      "internationalization_custom_component_localization",
      "internationalization_translation",
    ],
    Documentation: [
      "documentation_index",
      "documentation_standards",
      "documentation_create_page",
    ],
    Intents: [
      "intent_index",
      "intent_firing",
      "intent_handling",
      "intent_conversation",
      "intent_builtin",
    ],
    "Building a Python library": [
      "api_lib_index",
      "api_lib_auth",
      "api_lib_data_models",
    ],
    asyncio: [
      "asyncio_index",
      "asyncio_101",
      "asyncio_categorizing_functions",
      "asyncio_working_with_async",
    ],
    "Hass.io": ["hassio_debugging", "hassio_hass"],
    "Hass.io Add-Ons": [
      "hassio_addon_index",
      "hassio_addon_tutorial",
      "hassio_addon_config",
      "hassio_addon_communication",
      "hassio_addon_testing",
      "hassio_addon_publishing",
      "hassio_addon_presentation",
      "hassio_addon_repository",
      "hassio_addon_security",
    ],
    "Maintainer docs": ["maintenance", "releasing"],
  },
};