Skip to content

docs: streamline and split into components #23

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.

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
merged 1 commit into from
Jun 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
848 changes: 13 additions & 835 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ composer install
#### Configuration

Depending on the examples you want to run, you may need to configure the needed API keys. Therefore, you need to create a
`.env.local` file in the root of the examples directory. This file should contain the environment variables for the
`.env.local` file in the root of the examples' directory. This file should contain the environment variables for the
corresponding example you want to run.

_Now you can run examples standalone or via the example runner._
Expand Down
25 changes: 25 additions & 0 deletions src/agent/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Symfony AI - Agent Component

The Agent component provides a framework for building AI agents that, sits on top of the Platform and Store components,
allowing you to create agents that can interact with users, perform tasks, and manage workflows.

**This Component is experimental**.
[Experimental features](https://symfony.com/doc/current/contributing/code/experimental.html)
are not covered by Symfony's
[Backward Compatibility Promise](https://symfony.com/doc/current/contributing/code/bc.html).

## Installation

```bash
composer require symfony/ai-agent
```

**This repository is a READ-ONLY sub-tree split**. See
https://github.com/symfony/ai to create issues or submit pull requests.

## Resources

- [Documentation](doc/index.rst)
- [Report issues](https://github.com/symfony/ai/issues) and
[send Pull Requests](https://github.com/symfony/ai/pulls)
in the [main Symfony AI repository](https://github.com/symfony/ai)
Loading