Skip to content

Commit 74477df

Browse files
committed
minor #23 docs: streamline and split into components (chr-hertel)
This PR was merged into the main branch. Discussion ---------- docs: streamline and split into components | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | Docs? | yes | Issues | | License | MIT Splitting large README into component specific ones. - [x] examples - [x] agent - [x] ai-bundle - [x] mcp-bundle - [x] platform - [x] store Also solves #25 Commits ------- dd38482 docs: split into components
2 parents f54efd0 + dd38482 commit 74477df

File tree

16 files changed

+1257
-1068
lines changed

16 files changed

+1257
-1068
lines changed

README.md

Lines changed: 13 additions & 835 deletions
Large diffs are not rendered by default.

examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ composer install
2020
#### Configuration
2121

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

2626
_Now you can run examples standalone or via the example runner._

src/agent/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Symfony AI - Agent Component
2+
3+
The Agent component provides a framework for building AI agents that, sits on top of the Platform and Store components,
4+
allowing you to create agents that can interact with users, perform tasks, and manage workflows.
5+
6+
**This Component is experimental**.
7+
[Experimental features](https://symfony.com/doc/current/contributing/code/experimental.html)
8+
are not covered by Symfony's
9+
[Backward Compatibility Promise](https://symfony.com/doc/current/contributing/code/bc.html).
10+
11+
## Installation
12+
13+
```bash
14+
composer require symfony/ai-agent
15+
```
16+
17+
**This repository is a READ-ONLY sub-tree split**. See
18+
https://github.com/symfony/ai to create issues or submit pull requests.
19+
20+
## Resources
21+
22+
- [Documentation](doc/index.rst)
23+
- [Report issues](https://github.com/symfony/ai/issues) and
24+
[send Pull Requests](https://github.com/symfony/ai/pulls)
25+
in the [main Symfony AI repository](https://github.com/symfony/ai)

0 commit comments

Comments
 (0)