Skip to content

Rework agents docs: simplify, fix links, update skills#2282

Merged
gary149 merged 19 commits intomainfrom
docs/hf-skills-add-cli
Mar 11, 2026
Merged

Rework agents docs: simplify, fix links, update skills#2282
gary149 merged 19 commits intomainfrom
docs/hf-skills-add-cli

Conversation

@gary149
Copy link
Contributor

@gary149 gary149 commented Mar 11, 2026

Summary

  • agents.md: Complete rewrite as a concise landing page with navigation table, condensed tiny-agents/Gradio/smolagents sections (210 → 70 lines)
  • agents-cli.md: Renamed to "Hugging Face CLI for AI Agents", simplified install section, added hf skills add quick install, tightened intro copy
  • agents-skills.md: Rewritten with all 13 skills from the repo (was 5), clearer AI/ML framing, proper install instructions for Claude Code/Codex/Gemini CLI/Cursor
  • agents-overview.md: Added navigation table, fixed 4 broken links (./agens-*./agents-*), reordered link lists consistently
  • _toctree.yml: Moved CLI page to 2nd position (right after "Agents on the Hub"), updated title
  • index.md: Updated sidebar link text

Cross-cutting: standardized link ordering (CLI, MCP Server, Skills, SDK) across all pages, removed duplicated content, removed --help terminal dumps and informal tone.

Test plan

  • Local preview verified at localhost:5174
  • Verify doc-build CI preview renders correctly

Note

Low Risk
Docs-only changes (copy, links, and navigation) with no runtime or security impact; main risk is broken/misleading links if any references were missed.

Overview
Reworks the Hub Agents documentation to be more navigable and consistent: adds quick navigation tables, standardizes link ordering across pages, and fixes broken ./agens-* links.

Updates the CLI and Skills guides to reflect current recommended installs and naming: renames the CLI page to "Hugging Face CLI for AI Agents", replaces long install/usage blocks with hf skills add and updated Claude plugin instructions (hf-cli@huggingface/skills), and expands the Skills page to a fuller curated list with updated install steps for Claude Code/Codex/Gemini CLI/Cursor. The Agents landing page (agents.md) is heavily condensed into a short entrypoint with pointers to tiny-agents, Gradio MCP, and smolagents, and navigation (_toctree.yml, index.md) is updated to surface the CLI page earlier with the new title.

Written by Cursor Bugbot for commit 90c0a3c. This will update automatically on new commits. Configure here.

Document the `hf skills add --claude --global` command as a quick
install option before the existing plugin-based instructions.
@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.

gary149 added 3 commits March 11, 2026 10:10
The `hf skills add` command only installs the hf-cli skill, so it
belongs on the CLI-specific page rather than the general skills page.
This is the best onboarding path for agents on the Hub. Tightened the
intro and restructured around install CLI → add skill → use it.
@gary149 gary149 marked this pull request as draft March 11, 2026 09:24
gary149 added 9 commits March 11, 2026 10:28
Replace inline CLI install instructions with a link to the existing
guide. Add `hf skills add` as the primary way to install the CLI skill.
Rewrite agents.md as a concise hub page with a navigation table,
condensed tiny-agents/Gradio/smolagents sections, and no duplicated
content. Fix 4 broken links in agents-overview.md (./agens-* -> ./agents-*).
Standardize link ordering to CLI, MCP Server, Skills, SDK across
agents-overview.md. Add CLI skill tip to top of agents-skills.md.
Move CLI before MCP Server in agents.md table.
@gary149 gary149 changed the title docs: add hf skills add quick install to Skills page Rework agents docs: simplify, fix links, update skills Mar 11, 2026
@gary149 gary149 marked this pull request as ready for review March 11, 2026 10:16
@gary149 gary149 requested a review from julien-c March 11, 2026 11:18
## Available Skills

Hugging Face Skills are available in the [Hugging Face Skills repository](https://github.com/huggingface/skills) and include two types of skills:
| Skill | What it does |
Copy link
Contributor

Choose a reason for hiding this comment

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

Not for this PR, but do we have a way to generate this content from the skills repo, else it's a constant maintenance churn (or include it, or just link to)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes let's do that later also I'll update to use your installer as default it's going to be way nicer.

Copy link
Contributor

@hanouticelina hanouticelina left a comment

Choose a reason for hiding this comment

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

thanks!

Copy link
Contributor

Choose a reason for hiding this comment

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

imo this page should be the main section page (i.e. changing line 437 in _toctree.yml from agents -> agents-overview). we can move agents.md into a subsection (Agents libraries?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes I agree in another PR because it's already a lot of changes here.

Co-authored-by: Julien Chaumond <julien@huggingface.co>
@gary149 gary149 merged commit a3f272f into main Mar 11, 2026
3 checks passed
@gary149 gary149 deleted the docs/hf-skills-add-cli branch March 11, 2026 17:41
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.

5 participants