Kong / Kong/developer.konghq.com

Improved conceptual introduction to AI Gateway

Open
#5,578 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

internal kapa-audit product:ai-gateway
Dominant language
Ruby
Stars
28
Forks
121
Avg merge
1d 4h
Merged PRs (30d)
313

Description

Jobs to be done

We don't provide a prominent big-picture overview of AI gateway. The existing quickstart just gives you minimal set up and tear down instructions without any motivation and the landing page speaks at a higer level of abstraction.

We often assume a degree of familiarity with LLM deployments but questions like:

We should describe a minimal proxying setup, highlighting how how Gateways, Providers, and Models are related. This should include a mermaid diagram. As an appendix talk about adding policies into this basic setup.

Definition of done

New overview page or additions to the landing page and quickstart.

Size

  • L (Large) Example: adding an API/Terraform how to, writing a reference page, writing a how to that involves a known third-party product (like Okta or Auth0)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing quickstart and landing page to understand their current scope and find the best place for the overview. The finished documentation should explain a minimal proxying setup, show how Gateways, Providers, and Models relate with a Mermaid diagram, and include an appendix on adding policies.

Written by the indexing model from the issue text.

Assessment

Domain
ai, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.