docs: modernize theme, landing page, and API code samples by leseb · Pull Request #5410 · ogx-ai/ogx

leseb · 2026-04-01T19:40:39Z

Summary

Comprehensive docs overhaul - theme, landing page, API code samples, and polish.

Theme (`docs/src/css/custom.css`)

Inter + JetBrains Mono fonts
Purple/teal palette, dark mode as default
Frosted glass navbar, One Dark syntax highlighting
Tighter sidebar with uppercase category labels
Better tables: rounded corners, zebra striping, hover highlights
Hide emoji icons on API category cards

Landing page (`docs/src/pages/index.js`)

Dark/light adaptive hero with gradient text
Endpoint cards in 3-column grid
Architecture diagram section
Provider tags by category
Compact community links
Fully responsive

API code samples (`scripts/openapi_generator/code_samples.py`)

OpenAI Python SDK examples for all 38 stable endpoints via x-codeSamples
Postinstall patch to hide auto-generated http.client/requests when custom samples exist
Only Python (OpenAI) and curl tabs shown (removed Java, NodeJS)
Fix Batches tag displayName (was showing full description)

Content fixes

Add File Processors, Admin, Rerank, Connectors to API overview grid
Replace oversized buttons with inline links on docs index

Docusaurus config

Dark mode default with respectPrefersColorScheme
One Dark code theme via prism-react-renderer

Test plan

Previewed locally with npx docusaurus start
Light and dark modes both work
API code samples show OpenAI Python SDK
Tables render with new styling
Pre-commit passes

🤖 Generated with Claude Code

Theme: - Inter + JetBrains Mono fonts, purple/teal palette - Dark mode as default, frosted glass navbar - One Dark syntax highlighting, better tables with rounded corners - Tighter sidebar with uppercase category labels Landing page: - Dark/light adaptive hero with gradient text - Endpoint cards, architecture diagram, provider tags - Fully responsive API code samples: - Add OpenAI Python SDK examples for all 38 endpoints via x-codeSamples - Patch plugin to hide auto-generated http.client/requests when custom samples exist - Remove Java and NodeJS language tabs - Fix Batches tag displayName Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Sébastien Han <seb@redhat.com>

Smaller padding, radius, icons, and text for the bottom link cards. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Sébastien Han <seb@redhat.com>

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Sébastien Han <seb@redhat.com>

Add Admin, Rerank, File Processors, and Connectors to the experimental APIs section. These were in the sidebar but missing from the overview grid. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Sébastien Han <seb@redhat.com>

…overview Hide the document emoji icons on API category pages. Add File Processors, Admin, Rerank, and Connectors to the experimental APIs overview grid. Replace oversized buttons with inline links on docs index. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Sébastien Han <seb@redhat.com>

github-actions · 2026-04-01T19:41:26Z

✱ Stainless preview builds

This PR will update the llama-stack-client SDKs with the following commit message.

docs: modernize theme, landing page, and API code samples

⚠️

llama-stack-client-openapi studio · code

Your SDK build had at least one "warning" diagnostic.
generate ⚠️

⚠️

llama-stack-client-python studio · conflict

Your SDK build had at least one warning diagnostic.

⚠️

llama-stack-client-node studio · conflict

Your SDK build had at least one warning diagnostic.

⚠️

llama-stack-client-go studio · conflict

Your SDK build had at least one error diagnostic.

This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push.
If you push custom code to the preview branch, re-run this workflow to update the comment.
Last updated: 2026-04-01 20:31:19 UTC

leseb · 2026-04-01T19:42:27Z

leseb · 2026-04-01T19:42:33Z

leseb · 2026-04-01T19:43:09Z

… links (#5411) ## Summary Comprehensive documentation fix addressing 12 issues found by cross-referencing docs against the current codebase. The docs had drifted significantly from the code, particularly around the agents-to-responses migration, provider registry changes, and API stability levels. - **API overview**: add missing APIs (Responses, Shields, Tools, Connectors, File Processors), fix stability levels (Datasets/DatasetIO are v1beta not v1alpha, Shields are stable not deprecated) - **Sidebar navigation**: remove Post Training category and sambanova-openai-compat (no longer in registry), add missing provider pages (responses, file_processors, inline_transformers, remote_oci, remote_llama-cpp-server, remote_passthrough, remote_openai) - **Stale provider pages**: delete docs for removed providers (remote_llama-cpp, remote_llama-server, remote_sambanova-openai-compat, inline_rag-runtime) - **Tools docs**: fix false claim that /v1/tools was removed, update RAG references from inline::rag-runtime to inline::file-search - **Configuration docs**: fix CLI syntax (positional arg not --config), update sample config from agents to responses - **Kubernetes configs**: update from agents to responses, replace inline::rag-runtime with inline::file-search - **Experimental APIs page**: rewrite to reflect actual v1alpha/v1beta APIs, remove stale 2024 roadmap - **Broken links**: fix relative paths in concepts/index, CLI reference, file operations docs - **CLI reference**: close unclosed code block - **SDK reference**: add deprecation notes for Agents and PostTraining sections - **Missing notebook**: remove link to non-existent Llama_Stack_Benchmark_Evals.ipynb > **Note**: `docs/docs/api-overview.mdx` overlaps with #5410. If that PR merges first, a trivial conflict resolution will be needed on that file (both PRs make the same type of corrections). ## Test plan - [ ] Run `npx docusaurus build` in docs/ to verify no broken links or build errors - [ ] Verify sidebar navigation shows all current providers - [ ] Verify stale provider pages are removed - [ ] Spot-check internal links resolve correctly 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Signed-off-by: Sébastien Han <seb@redhat.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

… links (ogx-ai#5411) ## Summary Comprehensive documentation fix addressing 12 issues found by cross-referencing docs against the current codebase. The docs had drifted significantly from the code, particularly around the agents-to-responses migration, provider registry changes, and API stability levels. - **API overview**: add missing APIs (Responses, Shields, Tools, Connectors, File Processors), fix stability levels (Datasets/DatasetIO are v1beta not v1alpha, Shields are stable not deprecated) - **Sidebar navigation**: remove Post Training category and sambanova-openai-compat (no longer in registry), add missing provider pages (responses, file_processors, inline_transformers, remote_oci, remote_llama-cpp-server, remote_passthrough, remote_openai) - **Stale provider pages**: delete docs for removed providers (remote_llama-cpp, remote_llama-server, remote_sambanova-openai-compat, inline_rag-runtime) - **Tools docs**: fix false claim that /v1/tools was removed, update RAG references from inline::rag-runtime to inline::file-search - **Configuration docs**: fix CLI syntax (positional arg not --config), update sample config from agents to responses - **Kubernetes configs**: update from agents to responses, replace inline::rag-runtime with inline::file-search - **Experimental APIs page**: rewrite to reflect actual v1alpha/v1beta APIs, remove stale 2024 roadmap - **Broken links**: fix relative paths in concepts/index, CLI reference, file operations docs - **CLI reference**: close unclosed code block - **SDK reference**: add deprecation notes for Agents and PostTraining sections - **Missing notebook**: remove link to non-existent Llama_Stack_Benchmark_Evals.ipynb > **Note**: `docs/docs/api-overview.mdx` overlaps with ogx-ai#5410. If that PR merges first, a trivial conflict resolution will be needed on that file (both PRs make the same type of corrections). ## Test plan - [ ] Run `npx docusaurus build` in docs/ to verify no broken links or build errors - [ ] Verify sidebar navigation shows all current providers - [ ] Verify stale provider pages are removed - [ ] Spot-check internal links resolve correctly 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Signed-off-by: Sébastien Han <seb@redhat.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

leseb and others added 5 commits April 1, 2026 21:24

docs: reduce community link card size

06e5884

Smaller padding, radius, icons, and text for the bottom link cards. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Sébastien Han <seb@redhat.com>

docs: replace oversized buttons with inline links on docs index

f6e13e2

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Sébastien Han <seb@redhat.com>

leseb requested review from ashwinb, bbrowning, cdoern, ehhuang, franciscojavierarceo, mattf and raghotham as code owners April 1, 2026 19:40

meta-cla Bot added the CLA Signed This label is managed by the Meta Open Source bot. label Apr 1, 2026

leseb enabled auto-merge April 1, 2026 19:43

leseb mentioned this pull request Apr 1, 2026

docs: fix documentation inconsistencies, stale references, and broken links #5411

Merged

4 tasks

franciscojavierarceo approved these changes Apr 1, 2026

View reviewed changes

leseb added this pull request to the merge queue Apr 1, 2026

Merged via the queue into ogx-ai:main with commit 85a1f2f Apr 1, 2026
23 checks passed

leseb deleted the docs-fresh branch April 1, 2026 20:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: modernize theme, landing page, and API code samples#5410

docs: modernize theme, landing page, and API code samples#5410
leseb merged 5 commits intoogx-ai:mainfrom
leseb:docs-fresh

leseb commented Apr 1, 2026

Uh oh!

github-actions Bot commented Apr 1, 2026 •

edited

Loading

Uh oh!

leseb commented Apr 1, 2026

Uh oh!

leseb commented Apr 1, 2026

Uh oh!

leseb commented Apr 1, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

leseb commented Apr 1, 2026

Summary

Theme (docs/src/css/custom.css)

Landing page (docs/src/pages/index.js)

API code samples (scripts/openapi_generator/code_samples.py)

Content fixes

Docusaurus config

Test plan

Uh oh!

github-actions Bot commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✱ Stainless preview builds

Uh oh!

leseb commented Apr 1, 2026

Uh oh!

leseb commented Apr 1, 2026

Uh oh!

leseb commented Apr 1, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Theme (`docs/src/css/custom.css`)

Landing page (`docs/src/pages/index.js`)

API code samples (`scripts/openapi_generator/code_samples.py`)

github-actions Bot commented Apr 1, 2026 •

edited

Loading