Skip to content

Commit 7abcaf8

Browse files
Add tiny-agents docs to ToC (#1496)
1 parent 80e27d6 commit 7abcaf8

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

.github/workflows/documentation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ on:
1111
- "README.md"
1212
- "packages/hub/README.md"
1313
- "packages/inference/README.md"
14-
- "packages/agents/README.md"
14+
- "packages/tiny-agents/README.md"
1515
- ".github/workflows/documentation.yml"
1616

1717
jobs:

.github/workflows/pr-documentation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
- "packages/hub/README.md"
99
- "packages/doc-internal/**"
1010
- "packages/inference/README.md"
11-
- "packages/agents/README.md"
11+
- "packages/tiny-agents/README.md"
1212

1313
concurrency:
1414
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}

docs/_toctree.yml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,12 @@
1818
isExpanded: true
1919
sections:
2020
- local: mcp-client/README
21-
title: Simple MCP Client and smol Agent built on top of Inference Client
22-
- title: "@huggingface/agent"
21+
title: Simple MCP Client built on top of Inference Client
22+
- title: "@huggingface/tiny-agents"
2323
isExpanded: true
2424
sections:
25-
- local: agents/README
26-
title: Use Agents to run multi-modal workflows from a natural language API
27-
- local: agents/modules
28-
title: API Reference
25+
- local: tiny-agents/README
26+
title: A lightweight MCP-powered Agent built on top of Inference Client
2927
- title: "@huggingface/space-header"
3028
isExpanded: true
3129
sections:

packages/doc-internal/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@
55
"description": "Package to generate doc for other @huggingface packages",
66
"private": true,
77
"scripts": {
8-
"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",
8+
"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",
99
"lint": "eslint --quiet --fix --ext .cjs,.ts .",
1010
"lint:check": "eslint --ext .cjs,.ts .",
1111
"format": "prettier --write .",
1212
"format:check": "prettier --check .",
1313
"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",
1414
"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",
15-
"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",
1615
"doc-gguf": "mkdir -p ../../docs/gguf && cp ../../packages/gguf/README.md ../../docs/gguf/README.md",
1716
"doc-mcp-client": "mkdir -p ../../docs/mcp-client && cp ../../packages/mcp-client/README.md ../../docs/mcp-client/README.md",
17+
"doc-tiny-agents": "mkdir -p ../../docs/tiny-agents && cp ../../packages/tiny-agents/README.md ../../docs/tiny-agents/README.md",
1818
"doc-space-header": "mkdir -p ../../docs/space-header && cp ../../packages/space-header/README.md ../../docs/space-header/README.md",
1919
"update-toc": "tsx update-toc.ts",
2020
"fix-cdn-versions": "tsx fix-cdn-versions.ts",

packages/tiny-agents/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Available Commands:
2929
serve Run the Agent as an OpenAI-compatible HTTP server
3030
```
3131

32+
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.
33+
3234
## Define your own agent
3335

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

0 commit comments

Comments
 (0)