From db7b9ca2af6e446e4be2a00716380dc1c90abb36 Mon Sep 17 00:00:00 2001 From: Adil Hafeez Date: Wed, 11 Feb 2026 20:26:04 -0800 Subject: [PATCH] Update remaining arch references in docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Rename RST cross-reference labels: arch_access_logging, arch_overview_tracing, arch_overview_threading → plano_* - Update label references in request_lifecycle.rst - Rename arch_config_state_storage_example.yaml → plano_config_state_storage_example.yaml - Update config YAML comments: "Arch creates/uses" → "Plano creates/uses" - Update "the Arch gateway" → "the Plano gateway" in configuration_reference.rst - Update arch_config_schema.yaml reference in provider_models.py - Rename arch_agent_router → plano_agent_router in config example Co-Authored-By: Claude Opus 4.6 --- docs/source/_ext/provider_models.py | 2 +- .../includes/agent/function-calling-agent.yaml | 2 +- docs/source/concepts/includes/plano_config.yaml | 4 ++-- docs/source/guides/includes/config.yaml | 4 ++-- docs/source/guides/observability/access_logging.rst | 2 +- docs/source/guides/observability/tracing.rst | 2 +- docs/source/resources/configuration_reference.rst | 2 +- .../resources/includes/plano_config_agents_filters.yaml | 2 +- .../resources/includes/plano_config_full_reference.yaml | 2 +- ...example.yaml => plano_config_state_storage_example.yaml} | 0 docs/source/resources/tech_overview/request_lifecycle.rst | 6 +++--- docs/source/resources/tech_overview/threading_model.rst | 2 +- 12 files changed, 15 insertions(+), 15 deletions(-) rename docs/source/resources/includes/{arch_config_state_storage_example.yaml => plano_config_state_storage_example.yaml} (100%) diff --git a/docs/source/_ext/provider_models.py b/docs/source/_ext/provider_models.py index 9b7451c5..96d954d9 100644 --- a/docs/source/_ext/provider_models.py +++ b/docs/source/_ext/provider_models.py @@ -19,7 +19,7 @@ def _on_build_finished(app: Sphinx, exception: Exception | None) -> None: return # Source path: provider_models.yaml is copied into the Docker image at /docs/provider_models.yaml - # This follows the pattern used for config templates like envoy.template.yaml and arch_config_schema.yaml + # This follows the pattern used for config templates like envoy.template.yaml and plano_config_schema.yaml docs_root = Path(app.srcdir).parent # Goes from source/ to docs/ source_path = docs_root / "provider_models.yaml" diff --git a/docs/source/build_with_plano/includes/agent/function-calling-agent.yaml b/docs/source/build_with_plano/includes/agent/function-calling-agent.yaml index bafd3b41..904b12ce 100644 --- a/docs/source/build_with_plano/includes/agent/function-calling-agent.yaml +++ b/docs/source/build_with_plano/includes/agent/function-calling-agent.yaml @@ -48,7 +48,7 @@ prompt_targets: description: Time range in days for which to gather device statistics. Defaults to 7. default: 7 -# Arch creates a round-robin load balancing between different endpoints, managed via the cluster subsystem. +# Plano creates a round-robin load balancing between different endpoints, managed via the cluster subsystem. endpoints: app_server: # value could be ip address or a hostname with port diff --git a/docs/source/concepts/includes/plano_config.yaml b/docs/source/concepts/includes/plano_config.yaml index e1dc0749..0b97e5b5 100644 --- a/docs/source/concepts/includes/plano_config.yaml +++ b/docs/source/concepts/includes/plano_config.yaml @@ -18,7 +18,7 @@ prompt_targets: endpoint: name: app_server path: /agent/summary - # Arch uses the default LLM and treats the response from the endpoint as the prompt to send to the LLM + # Plano uses the default LLM and treats the response from the endpoint as the prompt to send to the LLM auto_llm_dispatch_on_response: true # override system prompt for this prompt target system_prompt: You are a helpful information extraction assistant. Use the information that is provided to you. @@ -39,7 +39,7 @@ prompt_targets: default: false enum: [true, false] -# Arch creates a round-robin load balancing between different endpoints, managed via the cluster subsystem. +# Plano creates a round-robin load balancing between different endpoints, managed via the cluster subsystem. endpoints: app_server: # value could be ip address or a hostname with port diff --git a/docs/source/guides/includes/config.yaml b/docs/source/guides/includes/config.yaml index 41c06e79..a33341b4 100644 --- a/docs/source/guides/includes/config.yaml +++ b/docs/source/guides/includes/config.yaml @@ -24,7 +24,7 @@ prompt_targets: name: app_server path: /agent/summary http_method: POST - # Arch uses the default LLM and treats the response from the endpoint as the prompt to send to the LLM + # Plano uses the default LLM and treats the response from the endpoint as the prompt to send to the LLM auto_llm_dispatch_on_response: true # override system prompt for this prompt target system_prompt: You are a helpful information extraction assistant. Use the information that is provided to you. @@ -46,7 +46,7 @@ prompt_targets: default: false enum: [true, false] -# Arch creates a round-robin load balancing between different endpoints, managed via the cluster subsystem. +# Plano creates a round-robin load balancing between different endpoints, managed via the cluster subsystem. endpoints: app_server: # value could be ip address or a hostname with port diff --git a/docs/source/guides/observability/access_logging.rst b/docs/source/guides/observability/access_logging.rst index e3c6f325..3ca007b1 100644 --- a/docs/source/guides/observability/access_logging.rst +++ b/docs/source/guides/observability/access_logging.rst @@ -1,4 +1,4 @@ -.. _arch_access_logging: +.. _plano_access_logging: Access Logging ============== diff --git a/docs/source/guides/observability/tracing.rst b/docs/source/guides/observability/tracing.rst index 4b6d8090..02723b23 100644 --- a/docs/source/guides/observability/tracing.rst +++ b/docs/source/guides/observability/tracing.rst @@ -1,4 +1,4 @@ -.. _arch_overview_tracing: +.. _plano_overview_tracing: Tracing ======= diff --git a/docs/source/resources/configuration_reference.rst b/docs/source/resources/configuration_reference.rst index 9cd00b4c..8e040f75 100644 --- a/docs/source/resources/configuration_reference.rst +++ b/docs/source/resources/configuration_reference.rst @@ -4,7 +4,7 @@ Configuration Reference ======================= The following is a complete reference of the ``plano_config.yml`` that controls the behavior of a single instance of -the Arch gateway. This where you enable capabilities like routing to upstream LLm providers, defining prompt_targets +the Plano gateway. This where you enable capabilities like routing to upstream LLm providers, defining prompt_targets where prompts get routed to, apply guardrails, and enable critical agent observability features. .. literalinclude:: includes/plano_config_full_reference.yaml diff --git a/docs/source/resources/includes/plano_config_agents_filters.yaml b/docs/source/resources/includes/plano_config_agents_filters.yaml index e5aacc03..dfc8fe7b 100644 --- a/docs/source/resources/includes/plano_config_agents_filters.yaml +++ b/docs/source/resources/includes/plano_config_agents_filters.yaml @@ -30,7 +30,7 @@ listeners: - type: agent name: agent_1 port: 8001 - router: arch_agent_router + router: plano_agent_router agents: - id: rag_agent description: virtual assistant for retrieval augmented generation tasks diff --git a/docs/source/resources/includes/plano_config_full_reference.yaml b/docs/source/resources/includes/plano_config_full_reference.yaml index be3c18a2..cc3973e0 100644 --- a/docs/source/resources/includes/plano_config_full_reference.yaml +++ b/docs/source/resources/includes/plano_config_full_reference.yaml @@ -1,4 +1,4 @@ -# Arch Gateway configuration version +# Plano Gateway configuration version version: v0.3.0 # External HTTP agents - API type is controlled by request path (/v1/responses, /v1/messages, /v1/chat/completions) diff --git a/docs/source/resources/includes/arch_config_state_storage_example.yaml b/docs/source/resources/includes/plano_config_state_storage_example.yaml similarity index 100% rename from docs/source/resources/includes/arch_config_state_storage_example.yaml rename to docs/source/resources/includes/plano_config_state_storage_example.yaml diff --git a/docs/source/resources/tech_overview/request_lifecycle.rst b/docs/source/resources/tech_overview/request_lifecycle.rst index 349e29b8..61df546c 100644 --- a/docs/source/resources/tech_overview/request_lifecycle.rst +++ b/docs/source/resources/tech_overview/request_lifecycle.rst @@ -41,7 +41,7 @@ The request processing path in Plano has three main parts: These two subsystems are bridged with either the HTTP router filter, and the cluster manager subsystems of Envoy. -Also, Plano utilizes `Envoy event-based thread model `_. A main thread is responsible for the server lifecycle, configuration processing, stats, etc. and some number of :ref:`worker threads ` process requests. All threads operate around an event loop (`libevent `_) and any given downstream TCP connection will be handled by exactly one worker thread for its lifetime. Each worker thread maintains its own pool of TCP connections to upstream endpoints. +Also, Plano utilizes `Envoy event-based thread model `_. A main thread is responsible for the server lifecycle, configuration processing, stats, etc. and some number of :ref:`worker threads ` process requests. All threads operate around an event loop (`libevent `_) and any given downstream TCP connection will be handled by exactly one worker thread for its lifetime. Each worker thread maintains its own pool of TCP connections to upstream endpoints. Worker threads rarely share state and operate in a trivially parallel fashion. This threading model enables scaling to very high core count CPUs. @@ -130,8 +130,8 @@ Once a request completes, the stream is destroyed. The following also takes plac * The post-request :ref:`monitoring ` are updated (e.g. timing, active requests, upgrades, health checks). Some statistics are updated earlier however, during request processing. Stats are batched and written by the main thread periodically. -* :ref:`Access logs ` are written to the access log -* :ref:`Trace ` spans are finalized. If our example request was traced, a +* :ref:`Access logs ` are written to the access log +* :ref:`Trace ` spans are finalized. If our example request was traced, a trace span, describing the duration and details of the request would be created by the HCM when processing request headers and then finalized by the HCM during post-request processing. diff --git a/docs/source/resources/tech_overview/threading_model.rst b/docs/source/resources/tech_overview/threading_model.rst index 4f02ba15..4b5601c4 100644 --- a/docs/source/resources/tech_overview/threading_model.rst +++ b/docs/source/resources/tech_overview/threading_model.rst @@ -1,4 +1,4 @@ -.. _arch_overview_threading: +.. _plano_overview_threading: Threading Model ===============