toc.yml

items:
  - name: Microsoft Orleans documentation
    href: index.yml
    homepage: index.yml
  - name: Get started
    items:
      - name: Overview
        href: overview.md
      - name: Benefits
        href: benefits.md
      - name: "Migrate from Orleans 3.x to 7.0"
        href: migration-guide.md
  - name: Quickstarts
    items:
      - name: Build your first Orleans app
        href: quickstarts/build-your-first-orleans-app.md
      - name: Deploy and scale an Orleans app on Azure
        href: quickstarts/deploy-scale-orleans-on-azure.md
  - name: Grains
    items:
      - name: Develop grains
        href: grains/index.md
      - name: Grain references
        href: grains/grain-references.md
      - name: Grain identity
        href: grains/grain-identity.md
      - name: Grain placement
        href: grains/grain-placement.md
      - name: Grain placement filtering
        href: grains/grain-placement-filtering.md
      - name: Grain extensions
        href: grains/grain-extensions.md
      - name: Timers and reminders
        href: grains/timers-and-reminders.md
      - name: Observers
        href: grains/observers.md
      - name: Request scheduling
        href: grains/request-scheduling.md
      - name: Request context
        href: grains/request-context.md
      - name: Code generation
        href: grains/code-generation.md
      - name: Persistence
        items:
          - name: Grain persistence
            href: grains/grain-persistence/index.md
          - name: Azure Cosmos DB
            href: grains/grain-persistence/azure-cosmos-db.md
          - name: Relational storage (ADO.NET)
            href: grains/grain-persistence/relational-storage.md
          - name: Azure storage
            href: grains/grain-persistence/azure-storage.md
          - name: Amazon DynamoDB storage
            href: grains/grain-persistence/dynamodb-storage.md
      - name: Event sourcing
        items:
          - name: Overview
            href: grains/event-sourcing/index.md
          - name: JournaledGrain basics
            href: grains/event-sourcing/journaledgrain-basics.md
          - name: JournaledGrain diagnostics
            href: grains/event-sourcing/journaledgrain-diagnostics.md
          - name: Immediate/Delayed confirmation
            href: grains/event-sourcing/immediate-vs-delayed-confirmation.md
          - name: Notifications
            href: grains/event-sourcing/notifications.md
          - name: Event sourcing configuration
            href: grains/event-sourcing/event-sourcing-configuration.md
          - name: Built-in log-consistency providers
            href: grains/event-sourcing/log-consistency-providers.md
          - name: Replicated instances
            href: grains/event-sourcing/replicated-instances.md
      - name: Advanced features
        items:
          - name: External tasks and grains
            href: grains/external-tasks-and-grains.md
          - name: Interceptors
            href: grains/interceptors.md
          - name: GrainServices
            href: grains/grainservices.md
          - name: Stateless worker grains
            href: grains/stateless-worker-grains.md
          - name: Cancellation tokens
            href: grains/cancellation-tokens.md
          - name: Transactions
            href: grains/transactions.md
          - name: One-way requests
            href: grains/oneway.md
          - name: Grain lifecycle
            href: grains/grain-lifecycle.md
          - name: Interface versioning
            items:
              - name: Overview
                href: grains/grain-versioning/grain-versioning.md
              - name: Backward compatibility guidelines
                href: grains/grain-versioning/backward-compatibility-guidelines.md
              - name: Compatible grains
                href: grains/grain-versioning/compatible-grains.md
              - name: Version selector strategy
                href: grains/grain-versioning/version-selector-strategy.md
              - name: Deploying new versions of grains
                href: grains/grain-versioning/deploying-new-versions-of-grains.md
  - name: Streaming
    items:
      - name: Overview
        href: streaming/index.md
      - name: Streams QuickStart
        href: streaming/streams-quick-start.md
      - name: Why streams?
        href: streaming/streams-why.md
      - name: Broadcast channels
        href: streaming/broadcast-channel.md
      - name: Streams APIs
        href: streaming/streams-programming-APIs.md
      - name: Stream providers
        href: streaming/stream-providers.md
  - name: Host
    items:
      - name: Clients
        href: host/client.md
      - name: Silo lifecycle
        href: host/silo-lifecycle.md
      - name: Heterogeneous silos
        href: host/heterogeneous-silos.md
      - name: Grain directory
        href: host/grain-directory.md
      - name: PowerShell client module
        href: host/powershell-client.md
      - name: Configuration guide
        items:
          - name: Overview
            href: host/configuration-guide/index.md
          - name: Local development configuration
            href: host/configuration-guide/local-development-configuration.md
          - name: Client configuration
            href: host/configuration-guide/client-configuration.md
          - name: Server configuration
            href: host/configuration-guide/server-configuration.md
          - name: Typical configurations
            href: host/configuration-guide/typical-configurations.md
          - name: Options classes
            href: host/configuration-guide/list-of-options-classes.md
          - name: Silo metadata
            href: host/configuration-guide/silo-metadata.md
          - name: Activation collection
            href: host/configuration-guide/activation-collection.md
          - name: Configure .NET garbage collection
            href: host/configuration-guide/configuring-garbage-collection.md
          - name: Configure ADO.NET providers
            href: host/configuration-guide/configuring-ado-dot-net-providers.md
          - name: ADO.NET database configuration
            href: host/configuration-guide/adonet-configuration.md
          - name: Serialization
            items:
              - name: Overview
                href: host/configuration-guide/serialization.md
              - name: Serialization of immutable types
                href: host/configuration-guide/serialization-immutability.md
              - name: Configure serialization
                href: host/configuration-guide/serialization-configuration.md
              - name: Customize serialization
                href: host/configuration-guide/serialization-customization.md
          - name: Startup tasks
            href: host/configuration-guide/startup-tasks.md
          - name: Orleans graceful shut down
            href: host/configuration-guide/shutting-down-orleans.md
      - name: Observability
        items:
          - name: Overview
            href: host/monitoring/index.md
            displayName: zipkin,jaeger,OpenTelemetry,opentelemetry,meter,counter,activity source,observability,monitoring,logging,metrics,telemetry,distributed tracing
          - name: Silo error code monitoring
            href: host/monitoring/silo-error-code-monitoring.md
          - name: Client error code monitoring
            href: host/monitoring/client-error-code-monitoring.md
  - name: Deployment
    items:
      - name: Running the app
        href: deployment/index.md
      - name: Azure App Service
        href: deployment/deploy-to-azure-app-service.md
      - name: Azure Container Apps
        href: deployment/deploy-to-azure-container-apps.md
      - name: Kubernetes
        href: deployment/kubernetes.md
      - name: Service fabric
        href: deployment/service-fabric.md
      - name: Handle failures
        href: deployment/handling-failures.md
      - name: Troubleshooting Azure Cloud Services deployments
        href: deployment/troubleshooting-azure-cloud-services-deployments.md
      - name: Consul deployments
        href: deployment/consul-deployment.md
      - name: Docker deployment
        href: deployment/docker-deployment.md
      - name: Troubleshoot deployments
        href: deployment/troubleshooting-deployments.md
      - name: Multi-cluster support
        items:
          - name: Overview
            href: deployment/multi-cluster-support/overview.md
          - name: Multi-cluster configuration
            href: deployment/multi-cluster-support/multi-cluster-configuration.md
          - name: Gossip channels
            href: deployment/multi-cluster-support/gossip-channels.md
          - name: Silo configuration
            href: deployment/multi-cluster-support/silo-configuration.md
          - name: Global-single-instance grains
            href: deployment/multi-cluster-support/global-single-instance.md
  - name: Code samples
    items:
      - name: Overview
        href: tutorials-and-samples/index.md
      - name: Hello World
        href: tutorials-and-samples/overview-helloworld.md
      - name: Orleans basics
        href: tutorials-and-samples/tutorial-1.md
      - name: Adventure game
        href: tutorials-and-samples/adventure.md
      - name: Unit testing
        href: implementation/testing.md
      - name: Custom grain storage
        href: tutorials-and-samples/custom-grain-storage.md
  - name: Implementation details
    items:
      - name: Overview
        href: implementation/index.md
      - name: Grain directory
        href: implementation/grain-directory.md
      - name: Orleans lifecycle
        href: implementation/orleans-lifecycle.md
      - name: Messaging delivery guarantees
        href: implementation/messaging-delivery-guarantees.md
      - name: Scheduling
        href: implementation/scheduler.md
      - name: Cluster management
        href: implementation/cluster-management.md
      - name: Streams implementation
        items:
          - name: Overview
            href: implementation/streams-implementation/index.md
          - name: Azure Queue streams
            href: implementation/streams-implementation/azure-queue-streams.md
      - name: Load balancing
        href: implementation/load-balancing.md
      - name: Unit testing
        href: implementation/testing.md
  - name: Resources
    items:
      - name: Frequently asked questions
        href: resources/frequently-asked-questions.md
      - name: Design principles
        href: resources/orleans-architecture-principles-and-approach.md
      - name: Applicability
        href: resources/orleans-thinking-big-and-small.md
      - name: NuGet packages
        href: resources/nuget-packages.md
      - name: Best practices
        href: resources/best-practices.md
      - name: Student projects
        href: resources/student-projects.md
      - name: External links
        href: resources/links.md