Adil/fix salman docs (#75)

* added the first set of docs for our technical docs

* more docuemtnation changes

* added support for prompt processing and updated life of a request

* updated docs to including getting help sections and updated life of a request

* committing local changes for getting started guide, sample applications, and full reference spec for prompt-config

* updated configuration reference, added sample app skeleton, updated favico

* fixed the configuration refernce file, and made minor changes to the intent detection. commit v1 for now

* Updated docs with use cases and example code, updated what is arch, and made minor changes throughout

* fixed imaged and minor doc fixes

* add sphinx_book_theme

* updated README, and make some minor fixes to documetnation

* fixed README.md

* fixed image width

---------

Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-261.local>
Co-authored-by: Adil Hafeez <adil@katanemo.com>
This commit is contained in:
Salman Paracha 2024-09-24 13:54:17 -07:00 committed by GitHub
parent 2d31aeaa36
commit 13dff3089d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
33 changed files with 931 additions and 287 deletions

View file

@ -1,13 +1,13 @@
Configuration Reference
============================
The following is a complete reference of the prompt-conifg.yml that controls the behavior of an Arch gateway.
We've kept things simple (less than 100 lines) and held off on exposing additional functionality (for e.g. suppporting
push observability stats, managing prompt-endpoints as virtual cluster, expose more load balancing options to endpoints,
etc). Our focus has been to choose the best defaults for developers, so that they can spend more of their time in building
features unique to their AI experience.
The following is a complete reference of the prompt-conifg.yml that controls the behavior of an Arch gateway.
We've kept things simple (less than 100 lines) and held off on exposing additional functionality (for e.g. suppporting
push observability stats, managing prompt-endpoints as virtual cluster, exposing more load balancing options, etc). Our
belief that the simple things, should be simple. So we offert good defaults for developers, so that they can spend more
of their time in building features unique to their AI experience.
.. literalinclude:: /_config/prompt-config-full-reference.yml
:language: yaml
:linenos:
:caption: :download:`prompt-config-full-reference-beta-1-0.yml </_config/prompt-config-full-reference.yml>`
:caption: :download:`prompt-config-full-reference-beta-1-0.yml </_config/prompt-config-full-reference.yml>`