apunkt/plano
1
0
Fork 0
mirror of https://github.com/katanemo/plano.git synced 2026-05-01 11:56:29 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Doc Update (#129)

Browse source 
* init update

* Update terminology.rst

* fix the branch to create an index.html, and fix pre-commit issues

* Doc update

* made several changes to the docs after Shuguang's revision

* fixing pre-commit issues

* fixed the reference file to the final prompt config file

* added google analytics

---------

Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-261.local>
This commit is contained in:
Shuguang Chen 2024-10-06 16:54:34 -07:00 • committed by GitHub
parent 2a7b95582c
commit 5c7567584d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
49 changed files with 1185 additions and 609 deletions
Download patch file Download diff file Expand all files Collapse all files

91
docs/source/get_started/overview.rst Normal file
View file

@ -0,0 +1,91 @@
Overview
============
Welcome to Arch, the intelligent prompt gateway designed to help developers build **fast**, **secure**, and **personalized** generative AI apps at ANY scale.
In this documentation, you will learn how to quickly set up Arch to trigger API calls via prompts, apply prompt guardrails without writing any application-level logic,
simplify the interaction with upstream LLMs, and improve observability all while simplifying your application development process.
Get Started
-----------
This section introduces you to Arch and helps you get set up quickly:
.. grid:: 3
.. grid-item-card:: Overview
:link: overview.html
Overview of Arch and Doc navigation
.. grid-item-card:: Intro to Arch
:link: intro_to_arch.html
Explore Arch's features and developer workflow
.. grid-item-card:: Quickstart
:link: quickstart.html
Learn how to quickly set up and integrate
Concepts
--------
Deep dive into essential ideas and mechanisms behind Arch:
.. grid:: 3
.. grid-item-card:: Tech Overview
:link: ../Concepts/tech_overview/tech_overview.html
Learn about the technology stack
.. grid-item-card:: LLM Provider
:link: ../Concepts/llm_provider.html
Explore Arch’s LLM integration options
.. grid-item-card:: Targets
:link: ../Concepts/prompt_target.html
Understand how Arch handles prompts
Guides
------
Step-by-step tutorials for practical Arch use cases and scenarios:
.. grid:: 3
.. grid-item-card:: Prompt Guard
:link: ../guides/tech_overview/tech_overview.html
Instructions on securing and validating prompts
.. grid-item-card:: Function Calling
:link: ../guides/function_calling.html
A guide to effective function calling
.. grid-item-card:: Observability
:link: ../guides/prompt_target.html
Learn to monitor and troubleshoot Arch
Build with Arch
---------------
For developers extending and customizing Arch for specialized needs:
.. grid:: 2
.. grid-item-card:: Agentic Workflow
:link: ../build_with_arch/agent.html
Discover how to create and manage custom agents within Arch
.. grid-item-card:: RAG Application
:link: ../build_with_arch/rag.html
Integrate RAG for knowledge-driven responses