apunkt/plano
1
0
Fork 0
mirror of https://github.com/katanemo/plano.git synced 2026-06-05 14:45:15 +02:00
Code Issues Projects Releases Packages Wiki Activity

updating docs to reflect changes in 0.1.2 like tracing via signoz and… (#271)

Browse source
This commit is contained in:
Salman Paracha 2024-11-15 16:55:27 -08:00 • committed by GitHub
parent d3c17c7abd
commit a0d87d86c9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 14 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
docs/source/_static/img/tracing.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 692 KiB

4
docs/source/concepts/tech_overview/listener.rst
View file

@ -21,8 +21,8 @@ Upstream (Egress)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Arch automatically configures a listener to route requests from your application to upstream LLM API providers (or hosts).
When you start Arch, it creates a listener for egress traffic based on the presence of the ``listener`` configuration
section in the configuration file. Arch binds itself to a local address such as ``127.0.0.1:9000/v1`` or a DNS-based
address like ``arch.local:9000/v1`` for outgoing traffic. For more details on LLM providers, read :ref:`here <llm_provider>`.
section in the configuration file. Arch binds itself to a local address such as ``127.0.0.1:12000/v1`` or a DNS-based
address like ``arch.local:12000/v1`` for outgoing traffic. For more details on LLM providers, read :ref:`here <llm_provider>`.
Configure Listener
^^^^^^^^^^^^^^^^^^

2
docs/source/conf.py
View file

@ -15,7 +15,7 @@ from sphinxawesome_theme.postprocess import Icons
project = "Arch Docs"
copyright = "2024, Katanemo Labs, Inc"
author = "Katanemo Labs, Inc"
release = " v0.1"
release = " v0.1.2"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

4
docs/source/guides/observability/tracing.rst
View file

@ -23,6 +23,10 @@ flow, enabling **end-to-end tracing** across the entire application. By using Op
that developers can capture this trace data consistently and in a format compatible with various observability
tools.
.. image:: /_static/img/tracing.png
:width: 100%
:align: center
Benefits of Using ``Traceparent`` Headers
-----------------------------------------

6
docs/source/index.rst
View file

@ -9,10 +9,12 @@ Welcome to Arch!
<div style="text-align: center; font-size: 1.25rem;">
<br>
<p>Build <strong>fast</strong>, <strong>robust</strong>, and <strong>personalized</strong> GenAI apps</p>
<p>Build <strong>fast</strong>, <strong>observable</strong>, and <strong>personalized</strong> GenAI apps</p>
</div>
Arch (built by the contributors of `Envoy <https://www.envoyproxy.io/>`_ ) was born out of the belief that:
<a href="https://www.producthunt.com/posts/arch-3?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-arch&#0045;3" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=565761&theme=light&period=daily" alt="Arch - Build&#0032;fast&#0044;&#0032;hyper&#0045;personalized&#0032;agents&#0032;with&#0032;intelligent&#0032;infra | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
`Arch <https://github.com/katanemo/arch>`_ is an intelligent infrastructure primitive for GenAI (built by the contributors of `Envoy <https://www.envoyproxy.io/>`_ ) that born out of the belief that:
*Prompts are nuanced and opaque user requests, which require the same capabilities as traditional HTTP requests including secure handling, intelligent routing, robust observability, and integration with backend (API) systems for personalization - all outside business logic.*