apunkt/plano
1
0
Fork 0
mirror of https://github.com/katanemo/plano.git synced 2026-04-26 09:16:24 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix errors and improve Doc (#143)

Browse source 
* Fix link issues and add icons

* Improve Doc

* fix test

* making minor modifications to shuguangs' doc changes

---------

Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-261.local>
Co-authored-by: Adil Hafeez <adil@katanemo.com>
This commit is contained in:
Shuguang Chen 2024-10-08 13:18:34 -07:00 • committed by GitHub
parent 3ed50e61d2
commit b30ad791f7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
27 changed files with 396 additions and 329 deletions
Download patch file Download diff file Expand all files Collapse all files

35
docs/source/get_started/overview.rst
View file

@ -1,3 +1,6 @@
.. _overview:
Overview
============
Welcome to Arch, the intelligent prompt gateway designed to help developers build **fast**, **secure**, and **personalized** generative AI apps at ANY scale.
@ -12,17 +15,17 @@ This section introduces you to Arch and helps you get set up quickly:
.. grid:: 3
.. grid-item-card:: Overview
.. grid-item-card:: :octicon:`apps` Overview
:link: overview.html
Overview of Arch and Doc navigation
.. grid-item-card:: Intro to Arch
.. grid-item-card:: :octicon:`book` Intro to Arch
:link: intro_to_arch.html
Explore Arch's features and developer workflow
.. grid-item-card:: Quickstart
.. grid-item-card:: :octicon:`rocket` Quickstart
:link: quickstart.html
Learn how to quickly set up and integrate
@ -35,18 +38,18 @@ Deep dive into essential ideas and mechanisms behind Arch:
.. grid:: 3
.. grid-item-card:: Tech Overview
:link: ../Concepts/tech_overview/tech_overview.html
.. grid-item-card:: :octicon:`package` Tech Overview
:link: ../concepts/tech_overview/tech_overview.html
Learn about the technology stack
.. grid-item-card:: LLM Provider
:link: ../Concepts/llm_provider.html
.. grid-item-card:: :octicon:`webhook` LLM Provider
:link: ../concepts/llm_provider.html
Explore Arch’s LLM integration options
.. grid-item-card:: Targets
:link: ../Concepts/prompt_target.html
.. grid-item-card:: :octicon:`workflow` Prompt Target
:link: ../concepts/prompt_target.html
Understand how Arch handles prompts
@ -57,18 +60,18 @@ 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
.. grid-item-card:: :octicon:`shield-check` Prompt Guard
:link: ../guides/prompt_guard.html
Instructions on securing and validating prompts
.. grid-item-card:: Function Calling
.. grid-item-card:: :octicon:`code-square` Function Calling
:link: ../guides/function_calling.html
A guide to effective function calling
.. grid-item-card:: Observability
:link: ../guides/prompt_target.html
.. grid-item-card:: :octicon:`issue-opened` Observability
:link: ../guides/observability/observability.html
Learn to monitor and troubleshoot Arch
@ -80,12 +83,12 @@ For developers extending and customizing Arch for specialized needs:
.. grid:: 2
.. grid-item-card:: Agentic Workflow
.. grid-item-card:: :octicon:`dependabot` Agentic Workflow
:link: ../build_with_arch/agent.html
Discover how to create and manage custom agents within Arch
.. grid-item-card:: RAG Application
.. grid-item-card:: :octicon:`stack` RAG Application
:link: ../build_with_arch/rag.html
Integrate RAG for knowledge-driven responses