Skip to content

Conversation

burtenshaw
Copy link
Collaborator

@burtenshaw burtenshaw commented Aug 19, 2025

This PR reorders the menu in inference providers.

(x-posting internal slack convo)

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

title: Function Calling
- local: guides/gpt-oss
title: How to use OpenAI gpt-oss

Copy link
Contributor

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

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

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

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

Copy link
Contributor

@NielsRogge NielsRogge left a comment

Choose a reason for hiding this comment

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

Thanks! Next up requests: add image-to-image and VLM task guides.

@burtenshaw burtenshaw requested a review from pcuenca August 22, 2025 08:24
Copy link
Member

@pcuenca pcuenca left a comment

Choose a reason for hiding this comment

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

It's a bit weird to me that API Reference | Index just points to tasks that are now located several levels above. Perhaps we could do something like:

  • Add tasks/index back to the first item of the Tasks section. Change the title from API Reference to something like Inference Tasks.
  • Keep the Hub API item last, if required, but call the section Hub API instead.

Copy link
Member

@Vaibhavs10 Vaibhavs10 left a comment

Choose a reason for hiding this comment

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

thought about it a bit, I don't have strong intuition about the order, would let @julien-c @Wauplin @hanouticelina chime in.

(probably better to wait till at least Wednesday before merge)

@tasal9
Copy link

tasal9 commented Aug 28, 2025

This pull request reorganizes the docs/inference-providers/_toctree.yml file to improve the structure and navigation of the documentation. The main changes include moving the Providers section and related pages to the end of the file, grouping API reference and provider registration pages together, and ensuring consistent formatting for expanded sections.

Documentation structure reorganization:

  • Moved the Providers section and all individual provider pages (providers/cerebras, providers/cohere, etc.) to the end of the file for better logical grouping. [1] [2]
  • Relocated the Hub API and Register as an Inference Provider pages to appear after the Providers section. [1] [2]
  • Merged the API Reference and Inference Tasks sections, renaming "Popular Tasks" to "Inference Tasks" and reorganizing their order for clarity.
  • Corrected the formatting of the isExpanded field in the Other Tasks section to use a capitalized "False" for consistency.

@tasal9
Copy link

tasal9 commented Aug 29, 2025

This pull request reorganizes the structure of the docs/inference-providers/_toctree.yml file to improve the documentation navigation and grouping. The main changes involve moving the Providers section and related API documentation entries to the end of the table of contents, as well as making minor formatting adjustments.

Documentation structure reorganization

  • Moved the Providers section (and all individual provider entries) from near the top of the file to the end, grouping them together for better clarity and navigation. [1] [2]
  • Relocated the Hub API and Register as an Inference Provider entries to the end of the file, after the Providers section. [1] [2]
  • Changed the API Reference section to "Inference Tasks" and adjusted its placement, consolidating related task documentation under this heading.
  • Corrected the isExpanded value in the Other Tasks section to use proper casing (False instead of false).

@tasal9
Copy link

tasal9 commented Aug 29, 2025

This pull request reorganizes the docs/inference-providers/_toctree.yml file to improve the structure and navigation of the documentation. The main changes involve moving the Providers section and related entries to the end of the file, consolidating API reference items, and fixing minor formatting issues.

Documentation structure reorganization:

  • Moved the Providers section and all individual provider entries (e.g., providers/cerebras, providers/cohere, etc.) from near the top of the file to the end, making the documentation flow more logical and grouping provider information together. [1] [2]
  • Relocated the register-as-a-provider and hub-api entries to the end of the file, along with the Providers section, for better discoverability and organization. [1] [2]
  • Consolidated the API Reference section into the Inference Tasks section and removed redundant entries, simplifying the navigation.
  • Corrected the casing of the isExpanded property for the "Other Tasks" section to ensure consistency (False instead of false).

@burtenshaw
Copy link
Collaborator Author

@tasal9 are you paid per comment?

Copy link
Contributor

@Wauplin Wauplin left a comment

Choose a reason for hiding this comment

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

Thanks @burtenshaw for opening this and @NielsRogge @pcuenca @Vaibhavs10 for the suggestions. Current proposition looks good to me expect the last two items that I would group in a new section. No strong opinion on the rest so pre-approving right now

Comment on lines +103 to +107
title: Hub API

- local: register-as-a-provider
title: Register as an Inference Provider
Copy link
Contributor

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


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

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 👍

title: Zero Shot Classification

- title: Providers
Copy link
Contributor

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

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.

7 participants