This repository was archived by the owner on Mar 25, 2026. It is now read-only.
Add Project Conventions section to Architecture documentation#139
Merged
Add Project Conventions section to Architecture documentation#139
Conversation
Co-Authored-By: Rick Blalock <rickblalock@mac.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
rblalock
suggested changes
May 14, 2025
|
|
||
| ## Project Conventions | ||
|
|
||
| Agentuity projects follow specific conventions that enable seamless development, testing, and deployment. Understanding these conventions helps you work with existing projects or create new ones from scratch. |
Member
There was a problem hiding this comment.
Something like:
"Agentuity projects follow specific conventions in order to take advantage of the deployment and cloud platform Agentuity offers. While we don't dictate which framework to use, we do have a few things you have to follow in your file system. Understanding these conventions are important."
| 1. **Consistent Development Experience** - Standardized structure makes it easier to work across projects | ||
| 2. **Automated Deployment** - The CLI can package and deploy your project without additional configuration | ||
| 3. **Framework Flexibility** - Use any agent framework while maintaining compatibility with the platform | ||
| 4. **Team Collaboration** - Common patterns make it easier for teams to work together |
Comment on lines
+184
to
+192
| ### Importing Existing Projects | ||
|
|
||
| If you have an existing agent project, you can adapt it to Agentuity by: | ||
|
|
||
| 1. Creating an `agentuity.yaml` file with your project configuration | ||
| 2. Organizing your agents according to the conventions above | ||
| 3. Running `agentuity project import` to register with the platform | ||
|
|
||
| The CLI will validate your project structure, generate necessary IDs, and set up API keys automatically. |
Co-Authored-By: Rick Blalock <rickblalock@mac.com>
rblalock
approved these changes
May 14, 2025
This was referenced Jun 30, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Project Conventions Section for Architecture Documentation
This PR adds a comprehensive Project Conventions section to the Architecture documentation, explaining:
This addresses the customer feedback about needing clearer documentation on project structure requirements and conventions.
Link to Devin run: https://app.devin.ai/sessions/b730a7e119a1401699a5d7ad3bb00203
Requested by: Rick Blalock