Skip to content
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

docs: rework structure #205

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

docs: rework structure #205

wants to merge 12 commits into from

Conversation

ismaelfaro
Copy link
Member

Which issue(s) does this pull-request address?

updating Docs to adding structure and architecture diagrams.

Closes: #

Description

Checklist

  • I have read the contributor guide
  • Linting passes: yarn lint or yarn lint:fix
  • Formatting is applied: yarn format or yarn format:fix
  • Unit tests pass: yarn test:unit
  • E2E tests pass: yarn test:e2e
  • Tests are included
  • Documentation is changed or added
  • Commit messages and PR title follow conventional commits

@ismaelfaro ismaelfaro requested a review from a team as a code owner December 2, 2024 05:58
@Tomas2D Tomas2D changed the title Updating DOCs docs: rework structure Dec 2, 2024
@Tomas2D Tomas2D added the documentation Improvements or additions to documentation label Dec 2, 2024
@matiasmolinas
Copy link

Here’s a revised draft of your comment incorporating the additional context:

Hi @ismaelfaro,

Thank you for updating the documentation with these structure and architecture diagrams! I reviewed the changes, and I find them incredibly useful, especially for developers new to this framework. Clear and detailed documentation like this not only improves onboarding but also aligns with modern development workflows.

For the issue I’m currently working on, my first step was to generate additional documentation—both for the framework as a whole and specifically for the issue I was addressing. This documentation served a dual purpose: helping me better understand the framework and providing structured context for an LLM to assist in drafting the initial implementation of the code.

From this perspective, I fully agree that improvements like the ones in this PR are not just enhancements but necessary steps for supporting new "developer workflows" that start by creating a solid understanding and leveraging LLMs as a tool to explore solutions.

Great work on this PR!

@ismaelfaro ismaelfaro force-pushed the agent_src2diagram branch 5 times, most recently from 5ee45d2 to 5561b8f Compare December 2, 2024 20:01
Signed-off-by: Ismael Faro <[email protected]>
Signed-off-by: Ismael Faro <[email protected]>
Signed-off-by: Ismael Faro <[email protected]>
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/agents.md Outdated Show resolved Hide resolved
docs/agents.md Outdated Show resolved Hide resolved
docs/agents.md Outdated Show resolved Hide resolved
docs/agents.md Outdated Show resolved Hide resolved
docs/agents.md Outdated Show resolved Hide resolved
docs/agents.md Outdated Show resolved Hide resolved
docs/agents.md Outdated Show resolved Hide resolved
docs/agents.md Show resolved Hide resolved
@ismaelfaro ismaelfaro requested a review from Tomas2D December 10, 2024 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants