Skip to content

[inference providers] reorder menu #1876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 3, 2025
Merged

[inference providers] reorder menu #1876

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
08fa866
reorder menu in inference providers
burtenshaw Aug 19, 2025
913c9d3
move api reference up
burtenshaw Aug 19, 2025
77b8230
only move tasks up and leave api reference below providers
burtenshaw Aug 20, 2025
8c20e78
use Inference Tasks and Hub API
burtenshaw Aug 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 49 additions & 51 deletions docs/inference-providers/_toctree.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,42 +6,9 @@
title: Pricing and Billing
- local: hub-integration
title: Hub integration
- local: register-as-a-provider
title: Register as an Inference Provider
- local: security
title: Security

- title: Providers
sections:
- local: providers/cerebras
title: Cerebras
- local: providers/cohere
title: Cohere
- local: providers/fal-ai
title: Fal AI
- local: providers/featherless-ai
title: Featherless AI
- local: providers/fireworks-ai
title: Fireworks
- local: providers/groq
title: Groq
- local: providers/hyperbolic
title: Hyperbolic
- local: providers/hf-inference
title: HF Inference
- local: providers/nebius
title: Nebius
- local: providers/novita
title: Novita
- local: providers/nscale
title: Nscale
- local: providers/replicate
title: Replicate
- local: providers/sambanova
title: SambaNova
- local: providers/together
title: Together

- title: Guides
sections:
- local: guides/first-api-call
Expand All @@ -55,25 +22,19 @@
- local: guides/gpt-oss
title: How to use OpenAI gpt-oss

Copy link
Contributor

@NielsRogge NielsRogge Aug 19, 2025

Choose a reason for hiding this comment

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

Would also put the task guides (like "chat completion", "text-to-image") below the guides, rather than below the individual providers.

Copy link
Collaborator Author

@burtenshaw burtenshaw Aug 19, 2025

Choose a reason for hiding this comment

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

So that would mean moving the API reference up? That's in here: 913c9d3

Copy link
Contributor

@NielsRogge NielsRogge Aug 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Well, technically I only consider the "index" and "hub API" to be API reference, those can indeed be the final section. However the "popular tasks" like "chat completion", "feature extraction" etc. aren't API reference to me (they explain the various tasks, so they belong to "guides" imo rather than "API reference")

Copy link
Collaborator Author

@burtenshaw burtenshaw Aug 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Yeah. That makes sense to me. I'll order it as you suggest and then hang on for another review, just because it's moved around a few times already.

it's in 77b8230


- title: API Reference
- local: tasks/index
title: Inference Tasks
Copy link
Contributor

@Wauplin Wauplin Aug 29, 2025

Choose a reason for hiding this comment

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

Makes perfect sense to rename this section, thanks for the suggestion 👍

Copy link
Member

@julien-c julien-c Aug 30, 2025

Choose a reason for hiding this comment

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

agree

sections:
- local: tasks/index
title: Index
- local: hub-api
title: Hub API
- title: Popular Tasks
sections:
- local: tasks/chat-completion
title: Chat Completion
- local: tasks/feature-extraction
title: Feature Extraction
- local: tasks/text-to-image
title: Text to Image
- local: tasks/text-to-video
title: Text to Video
- local: tasks/chat-completion
title: Chat Completion
- local: tasks/feature-extraction
title: Feature Extraction
- local: tasks/text-to-image
title: Text to Image
Copy link
Contributor

@NielsRogge NielsRogge Sep 1, 2025

Choose a reason for hiding this comment

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

I would also make Image-to-Image and VLMs separate task pages here (as follow-up PRs)

- local: tasks/text-to-video
title: Text to Video
- title: Other Tasks
isExpanded: false
isExpanded: False
sections:
- local: tasks/audio-classification
title: Audio Classification
Expand Down Expand Up @@ -106,4 +67,41 @@
- local: tasks/translation
title: Translation
- local: tasks/zero-shot-classification
title: Zero Shot Classification
title: Zero Shot Classification

- title: Providers
Copy link
Contributor

@Wauplin Wauplin Aug 29, 2025

Choose a reason for hiding this comment

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

no strong opinion whether to have "providers" below or above "tasks". Previous logic was to display our partners prominently but fine with moving them down if you prefer

Copy link
Member

@julien-c julien-c Aug 30, 2025

Choose a reason for hiding this comment

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

fine for me as well as long as Providers are not too hidden. Given Tasks is short, i'm fine with it being above

sections:
- local: providers/cerebras
title: Cerebras
- local: providers/cohere
title: Cohere
- local: providers/fal-ai
title: Fal AI
- local: providers/featherless-ai
title: Featherless AI
- local: providers/fireworks-ai
title: Fireworks
- local: providers/groq
title: Groq
- local: providers/hyperbolic
title: Hyperbolic
- local: providers/hf-inference
title: HF Inference
- local: providers/nebius
title: Nebius
- local: providers/novita
title: Novita
- local: providers/nscale
title: Nscale
- local: providers/replicate
title: Replicate
- local: providers/sambanova
title: SambaNova
- local: providers/together
title: Together

- local: hub-api
title: Hub API

- local: register-as-a-provider
title: Register as an Inference Provider
Comment on lines +103 to +107
Copy link
Contributor

@Wauplin Wauplin Aug 29, 2025

Choose a reason for hiding this comment

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

Suggested change
- local: hub-api
title: Hub API
- local: register-as-a-provider
title: Register as an Inference Provider
- title: Advanced
sections:
- local: hub-api
title: Hub API
- local: register-as-a-provider
title: Register as an Inference Provider

I would put these two in a grouped section for consistency. I'm fine with something like "Other" or "Misc" as well

Copy link
Member

@julien-c julien-c Aug 30, 2025

Choose a reason for hiding this comment

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

what about keeping "API Reference"? otherwise Advanced sounds fine to me

Copy link
Member

@Vaibhavs10 Vaibhavs10 Aug 31, 2025

Choose a reason for hiding this comment

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

API Reference sounds tad bit nicer to me.

Copy link
Member

@julien-c julien-c Sep 4, 2025

Choose a reason for hiding this comment

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

feels a bit weird to have them free-standing:
image