Skip to content

Add tiny-agents docs to ToC #1496

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
hanouticelina merged 9 commits into from
May 28, 2025
Merged

Add tiny-agents docs to ToC #1496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
bac717b
tiny-agents docs
hanouticelina May 27, 2025
20849d6
fix
hanouticelina May 27, 2025
f09982f
copy tiny-agents docs
hanouticelina May 27, 2025
d424683
fix script
hanouticelina May 27, 2025
b146667
nit
hanouticelina May 27, 2025
85fbc74
Merge branch 'main' of github.com:huggingface/huggingface.js into tin…
hanouticelina May 27, 2025
1d4fe45
update note
hanouticelina May 27, 2025
77cc499
remove huggingface/agents from ToC
hanouticelina May 27, 2025
f655e60
better
hanouticelina May 27, 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
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ on:
- "README.md"
- "packages/hub/README.md"
- "packages/inference/README.md"
- "packages/agents/README.md"
- "packages/tiny-agents/README.md"
- ".github/workflows/documentation.yml"

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pr-documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
- "packages/hub/README.md"
- "packages/doc-internal/**"
- "packages/inference/README.md"
- "packages/agents/README.md"
- "packages/tiny-agents/README.md"

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
Expand Down
10 changes: 4 additions & 6 deletions docs/_toctree.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,12 @@
isExpanded: true
sections:
- local: mcp-client/README
title: Simple MCP Client and smol Agent built on top of Inference Client
- title: "@huggingface/agent"
title: Simple MCP Client built on top of Inference Client
- title: "@huggingface/tiny-agents"
isExpanded: true
sections:
- local: agents/README
title: Use Agents to run multi-modal workflows from a natural language API
- local: agents/modules
title: API Reference
- local: tiny-agents/README
title: A lightweight MCP-powered Agent built on top of Inference Client
- title: "@huggingface/space-header"
isExpanded: true
sections:
Expand Down
4 changes: 2 additions & 2 deletions packages/doc-internal/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
"description": "Package to generate doc for other @huggingface packages",
"private": true,
"scripts": {
"start": "pnpm run fix-cdn-versions && pnpm run doc-hub && pnpm run doc-inference && pnpm run doc-agents && pnpm run doc-space-header && pnpm run doc-gguf && pnpm run doc-mcp-client && cp ../../README.md ../../docs/index.md && pnpm run update-toc && pnpm run fix-md-links && pnpm run fix-md-headinghashlinks",
"start": "pnpm run fix-cdn-versions && pnpm run doc-hub && pnpm run doc-inference && pnpm run doc-space-header && pnpm run doc-gguf && pnpm run doc-mcp-client && pnpm run doc-tiny-agents && cp ../../README.md ../../docs/index.md && pnpm run update-toc && pnpm run fix-md-links && pnpm run fix-md-headinghashlinks",
"lint": "eslint --quiet --fix --ext .cjs,.ts .",
"lint:check": "eslint --ext .cjs,.ts .",
"format": "prettier --write .",
"format:check": "prettier --check .",
"doc-hub": "typedoc --tsconfig ../hub/tsconfig.json --githubPages false --plugin typedoc-plugin-markdown --out ../../docs/hub --hideBreadcrumbs --hideInPageTOC --sourceLinkTemplate https://github.com/huggingface/huggingface.js/blob/main/{path}#L{line} ../hub/index.ts",
"doc-inference": "typedoc --tsconfig ../inference/tsconfig.json --githubPages false --plugin typedoc-plugin-markdown --out ../../docs/inference --hideBreadcrumbs --hideInPageTOC --sourceLinkTemplate https://github.com/huggingface/huggingface.js/blob/main/{path}#L{line} ../inference/src/index.ts",
"doc-agents": "typedoc --tsconfig ../agents/tsconfig.json --githubPages false --plugin typedoc-plugin-markdown --out ../../docs/agents --hideBreadcrumbs --hideInPageTOC --sourceLinkTemplate https://github.com/huggingface/huggingface.js/blob/main/{path}#L{line} ../agents/src/index.ts",
"doc-gguf": "mkdir -p ../../docs/gguf && cp ../../packages/gguf/README.md ../../docs/gguf/README.md",
"doc-mcp-client": "mkdir -p ../../docs/mcp-client && cp ../../packages/mcp-client/README.md ../../docs/mcp-client/README.md",
"doc-tiny-agents": "mkdir -p ../../docs/tiny-agents && cp ../../packages/tiny-agents/README.md ../../docs/tiny-agents/README.md",
"doc-space-header": "mkdir -p ../../docs/space-header && cp ../../packages/space-header/README.md ../../docs/space-header/README.md",
"update-toc": "tsx update-toc.ts",
"fix-cdn-versions": "tsx fix-cdn-versions.ts",
Expand Down
2 changes: 2 additions & 0 deletions packages/tiny-agents/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ Available Commands:
serve Run the Agent as an OpenAI-compatible HTTP server
```

You can load agents directly from the Hugging Face Hub [tiny-agents](https://huggingface.co/datasets/tiny-agents/tiny-agents) Dataset, or specify a path to your own local agent configuration.

## Define your own agent

The simplest way to create your own agent is to create a folder containing an `agent.json` file:
Expand Down