Restore xyz.md / xyz-overview.md convention for Agents section#2308
Merged
burtenshaw merged 3 commits intohuggingface:mainfrom Mar 20, 2026
Merged
Restore xyz.md / xyz-overview.md convention for Agents section#2308burtenshaw merged 3 commits intohuggingface:mainfrom
xyz.md / xyz-overview.md convention for Agents section#2308burtenshaw merged 3 commits intohuggingface:mainfrom
Conversation
huggingface#2289 made `agents-overview` the top-level toctree entry, breaking the pattern every other Hub section follows: spaces.md → spaces-overview.md jobs.md → jobs-overview.md datasets.md → datasets-overview.md models.md → models-the-hub.md This commit: - Creates a proper `agents.md` landing page (table-of-contents style, like `jobs.md` / `spaces.md`) - Renames the old `agents.md` (Agent Libraries content) to `agents-libraries.md` - Restores `agents` as the toctree root with `agents-overview` as the first child section Made-with: Cursor
mishig25
requested review from
burtenshaw,
gary149,
julien-c and
pcuenca
and removed request for
julien-c
|
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. |
Aligns the index.md HTML links with the new toctree structure: rename "Agents on the Hub" → "Agents Overview", reorder entries to match toctree, and add missing agents-local and agents-libraries links. Made-with: Cursor
hanouticelina
approved these changes
Mar 19, 2026
Contributor
hanouticelina
left a comment
hanouticelina
left a comment
There was a problem hiding this comment.
yes looks good to me, thanks!
(I hadn't noticed this convention when I suggested making agents-overview the top level toctree)
pcuenca
approved these changes
Mar 19, 2026
Co-authored-by: Pedro Cuenca <pedro@huggingface.co>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
#2289 made
agents-overviewthe top-level toctree entry for the Agents section, which breaks thexyz.md/xyz-overview.mdconvention that every other Hub doc section follows:xyz.md)spaces.mdspaces-overview.mdjobs.mdjobs-overview.mddatasets.mddatasets-overview.mdmodels.mdmodels-the-hub.mdnone—agents-overview.mdwas promotedagents.mddemoted to "Agent Libraries"This PR restores the convention by:
agents.mdlanding page — a table-of-contents style page (same format asjobs.md/spaces.md) with an introductory paragraph and links to all sub-pagesagents.md(Agent Libraries content) →agents-libraries.mdagentsas the toctree root withagents-overviewas the first child section, matching howspaces,jobs, anddatasetsare structuredNo content was removed — the Agent Libraries material is preserved in full at
agents-libraries.md.It will also fix this UI-bug
Made with Cursor
Note
Low Risk
Low risk documentation-only change that reshuffles the Agents docs navigation; main risk is broken links or unexpected sidebar ordering.
Overview
Restores the
xyz.md/xyz-overview.mdconvention for the Hub Agents docs by makingagents.mdthe landing page again and placingagents-overviewas the first subpage in the Agents toctree.Moves the previous “Agent Libraries” content out of
agents.mdinto a newagents-libraries.md, and updatesdocs/hub/index.md+_toctree.ymlto point to the new page and improve link labels (e.g., “Agents Overview”, “Building agents with the HF SDK”, “Local Agents”, “Agent Libraries”).Written by Cursor Bugbot for commit b5d8d8d. This will update automatically on new commits. Configure here.