From 4c6326cf77004fe99c5670857b7123f463c1070b Mon Sep 17 00:00:00 2001 From: Martin Krasser Date: Wed, 22 Jan 2025 13:25:22 +0100 Subject: [PATCH] Improve structure of user guide --- docs/quickstart.md | 2 +- mkdocs.yml | 28 +++++++++++++++------------- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 592cad6..43017df 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -16,7 +16,7 @@ ANTHROPIC_API_KEY=... GOOGLE_API_KEY=... ``` -Launch a `freeact` agent with generative Google Search skill using the CLI +Launch a `freeact` agent with generative Google Search skill using the [CLI](cli.md): ```bash python -m freeact.cli \ diff --git a/mkdocs.yml b/mkdocs.yml index 2196ac8..bc822ad 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -82,19 +82,21 @@ markdown_extensions: nav: - User guide: - - Overview: index.md - - Quickstart: quickstart.md - - Installation: installation.md - - Command line: cli.md - - Building blocks: blocks.md - - Supported models: models.md - - Streaming protocol: streaming.md - - Evaluation results: evaluation.md - - Tutorials: - - Overview: tutorials/index.md - - Basic usage: tutorials/basics.md - - Skill development: tutorials/skills.md - - System extensions: tutorials/extend.md + - Basics: + - Overview: index.md + - Quickstart: quickstart.md + - Installation: installation.md + - Building blocks: blocks.md + - Supported models: models.md + - Command line interface: cli.md + - Tutorials: + - Overview: tutorials/index.md + - Basic usage: tutorials/basics.md + - Skill development: tutorials/skills.md + - System extensions: tutorials/extend.md + - Advanced topics: + - Streaming protocol: streaming.md + - Evaluation results: evaluation.md - API Documentation: - Agent: api/agent.md - Executor: api/executor.md