Skip to content

docs: overhaul praxis.fast site for praxis + ai doc refresh#4

Open
rikatz wants to merge 3 commits into
praxis-proxy:mainfrom
rikatz:docs/overhaul
Open

docs: overhaul praxis.fast site for praxis + ai doc refresh#4
rikatz wants to merge 3 commits into
praxis-proxy:mainfrom
rikatz:docs/overhaul

Conversation

@rikatz

@rikatz rikatz commented Jul 10, 2026

Copy link
Copy Markdown

Summary

  • Restructure praxis.fast with product map, dual quickstart, full AI gateway docs, per-filter core pages, split filter references, and trimmed configuration overview
  • Add dual-repo examples catalog (109 entries), CI examples lint, and homepage pipeline link
  • Sync filter references, guardrails scaffold wording, token-counting phase limits, and filter_metadata docs against the current docs/overhaul branches in praxis and ai

Merge order

Do not merge this PR until the source doc overhauls land first:

  1. praxis-proxy/praxis#779 (docs/overhaul)
  2. praxis-proxy/ai#328 (docs/overhaul)

This website PR ports content from those branches; merging early risks drift if upstream doc wording or paths change during review.

Test plan

  • npm run build (broken link check passes)
  • scripts/lint-examples-catalog.sh (109/109 README rows match examples.ts)
  • Visual spot-check homepage, product map, AI filter reference tables after deploy preview

Made with Cursor

rikatz added 2 commits July 10, 2026 08:32
Restructure praxis.fast with product map, dual quickstart, AI gateway
docs, core filter pages, trimmed configuration overview, dual-repo
examples catalog, CI examples lint, and homepage pipeline link.
Align filter reference links, guardrails scaffold wording, token-counting
phase limits, and filter_metadata docs so praxis.fast matches the current
docs/overhaul branches in praxis and ai.

Signed-off-by: Ricardo Pchevuzinske Katz <katz@redhat.com>
@rikatz
rikatz requested a review from leseb July 10, 2026 11:33
Expand AI overview with AI-native proxy and ingress/egress patterns,
align product map and introduction with core traffic plane vs AI Gateway.

Signed-off-by: Ricardo Pchevuzinske Katz <katz@redhat.com>

@nathan-weinberg nathan-weinberg left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small suggestion as part of this refresh: the quickstart as it exists today requires steps from the installation page before it can be run - it may be good to either add some of the installation steps to the quick start, or point people their first in the docs nav (right now the quickstart precedes the installation page)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants