Codex/criar estrutura de pastas para docs/pt br e docs#628
Codex/criar estrutura de pastas para docs/pt br e docs#628Habdel-Edenfield wants to merge 41 commits intoMervinPraison:mainfrom Habdel-Edenfield:codex/criar-estrutura-de-pastas-para-docs/pt-br-e-docs
Conversation
… done so far and provide feedback for Jules to continue.
Este commit inclui os seguintes progressos na criação do curso em português:
1. **Estrutura de Pastas e Arquivos Iniciais:**
* Criei a pasta `docs/pt-br/` e subpastas para os módulos do curso.
* Adicionei `README.md` principal do curso e `00_como_usar_esta_documentacao.md` com sugestões de plugins Obsidian.
2. **Conteúdo Introdutório:**
* `00_introducao/01_o_que_e_praisonai.md`: Explicação do PraisonAI, recursos e diagramas Mermaid.
* `00_introducao/02_filosofia_e_casos_de_uso.md`: Filosofia do projeto e casos de uso.
3. **Guia de Instalação (Windows):**
* `01_instalacao/00_instalacao_windows.md`: Guia detalhado de instalação para Windows.
4. **Módulo: Conceitos Fundamentais:**
* `02_conceitos_fundamentais/01_agentes.md`
* `02_conceitos_fundamentais/02_tarefas.md`
* `02_conceitos_fundamentais/03_processos.md`
* `02_conceitos_fundamentais/04_ferramentas.md`
* `02_conceitos_fundamentais/05_memoria.md`
* `02_conceitos_fundamentais/06_conhecimento_rag.md`
Estes arquivos cobrem os blocos de construção do PraisonAI.
5. **Módulo: Usando o PraisonAI:**
* `03_usando_praisonai/01_usando_com_python.md`
* `03_usando_praisonai/02_usando_com_yaml.md`
* `03_usando_praisonai/03_usando_com_js_ts.md`
Estes arquivos explicam como usar o PraisonAI com diferentes abordagens.
O trabalho progrediu conforme o plano que você aprovou, focando na criação de conteúdo em português e estruturado para Obsidian. O próximo passo seria detalhar o módulo de 'Workflows Avançados'.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…66027 Jules wip 18426871776149966027
… done so far and provide feedback for Jules to continue.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…66027 Jules was unable to complete the task in time. Please review the work…
Este commit conclui a criação inicial e a revisão da documentação em português para o curso PraisonAI, formatada para Obsidian.
Trabalho Realizado:
1. **Estrutura Completa do Curso:**
* Criação da estrutura de pastas em `docs/pt-br/`.
* Adição de `README.md` do curso e guia `00_como_usar_esta_documentacao.md` (com sugestões de plugins Obsidian).
2. **Módulos de Conteúdo Criados:**
* **Introdução:** Visão geral do PraisonAI, filosofia e casos de uso.
* **Instalação:** Guia detalhado para ambiente Windows.
* **Conceitos Fundamentais:** Cobertura de Agentes, Tarefas, Processos, Ferramentas, Memória, Conhecimento/RAG.
* **Usando o PraisonAI:** Guias para Python (`praisonaiagents`), YAML (No-Code/Low-Code) e JavaScript/TypeScript.
* **Workflows Avançados:** Detalhamento de Processos de Colaboração, Roteamento Agêntico, Orquestrador-Trabalhador, Workflow Autônomo, Paralelização, Encadeamento de Prompts, Avaliador-Otimizador e Agentes Repetitivos.
* **Ferramentas (Tools):** Guia geral sobre uso e criação de ferramentas.
* **Modelos de LLM:** Guia sobre configuração de diferentes LLMs.
* **Exemplos Práticos Detalhados:** Três exemplos (Análise de Ações, Geração de Artigos, Análise/Geração de Código) com YAMLs conceituais.
* **Contribuindo e Desenvolvimento:** Guia para contribuir, configurar ambiente de dev local e executar testes.
3. **Revisão e Melhorias (Conforme Feedback):**
* **Remoção de Emojis:** Todos os arquivos foram revisados para remover emojis, visando um tom mais sério e profissional.
* **Padronização de Diagramas Mermaid:** Os diagramas Mermaid foram revisados para melhorar a compatibilidade com o Obsidian. Labels com espaços ou caracteres especiais foram colocados entre aspas duplas, e a sintaxe foi simplificada onde possível para evitar problemas de renderização.
* **Correções Pontuais:** Erros de sintaxe e caminhos de imagem apontados anteriormente foram corrigidos.
* **Consistência Geral:** Esforço para manter a consistência na formatação Markdown, links internos e terminologia.
Esta documentação visa ser um recurso didático completo para você aprender sobre o framework PraisonAI.
…66027 feat: Documentação completa do curso PraisonAI em Português (Revisada)
Mermaid repair
Mermaid repair v1
…ompleto-e-tutorial-detalhado Improve PT-BR docs
…ompleto-e-tutorial-detalhado add quickstart agent tutorial
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…curso-completo-e-tutorial-detalhado Add PT-BR FAQ
…curso-completo-e-tutorial-detalhado Add PT-BR course plan
…curso-completo-e-tutorial-detalhado Add PT-BR course plan
…curso-completo-e-tutorial-detalhado Add PT-BR intro and link features
* Improve docs and README * docs: expand configuration guides
* docs(pt-br): add lesson about key imports * Update docs/pt-br/03_usando_praisonai/07_importes_e_funcoes_essenciais.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
* docs(pt-br): add imports guide and update plan * Update docs/pt-br/plan.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update docs/pt-br/03_usando_praisonai/07_importes_e_funcoes_essenciais.md Co-authored-by: qodo-merge-pro[bot] <151058649+qodo-merge-pro[bot]@users.noreply.github.com> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: qodo-merge-pro[bot] <151058649+qodo-merge-pro[bot]@users.noreply.github.com>
* docs(pt-br): add lesson about key imports * Update docs/pt-br/03_usando_praisonai/07_importes_e_funcoes_essenciais.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
Caution Review failedThe pull request is closed. WalkthroughThis update introduces a comprehensive suite of new documentation files for PraisonAI, covering core concepts, advanced workflows, practical examples, installation, contributing guidelines, and FAQs in both English and Brazilian Portuguese. It also includes a minor test improvement, replacing a manual import error check with a pytest-native skip mechanism. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant CLI/Python/JS
participant Agent
participant Tool
participant LLM
participant Memory
User->>Docs: Reads installation and usage guides
User->>CLI/Python/JS: Runs agent via CLI, Python, or JS
CLI/Python/JS->>Agent: Instantiates agent(s) with config
Agent->>Tool: Invokes tool if needed
Agent->>LLM: Sends prompt/task
Agent->>Memory: Reads/writes context (optional)
LLM-->>Agent: Returns response
Tool-->>Agent: Returns tool result
Memory-->>Agent: Returns memory/context
Agent-->>CLI/Python/JS: Returns final output
CLI/Python/JS-->>User: Displays result
Possibly related PRs
Poem
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @Habdel-Edenfield, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
Gemini here, providing a summary for this pull request. The primary intent of this PR, as indicated by the title, is to establish a new folder structure for documentation, specifically including Portuguese (pt-br) documentation. The changes introduce a comprehensive set of documentation files covering various aspects of the PraisonAI framework, alongside minor updates to the main README and a test file. While the documentation content appears duplicated across docs/ and docs_translations/pt-br/ directories in this patch, the core change is the addition of extensive documentation in Portuguese.
Highlights
- Documentation Structure: New directories (
docs/,docs/00_introducao,docs/01_instalacao, etc., and their counterparts underdocs_translations/pt-br/) have been created to organize documentation files. - Portuguese Documentation Added: A large volume of documentation files in Portuguese (pt-br) has been added, covering fundamental concepts (Agents, Tasks, Processes, Tools, Memory, RAG), usage guides (Python, YAML, JS/TS), advanced workflows, LLM models, practical examples, contributing guidelines, and FAQs.
- README Update: The main README has been updated to reflect the project's status as a fork and a 'learning laboratory', and includes new links pointing to sections within the newly added Portuguese documentation. A section on local development setup has also been added.
- Test File Update: A minor change was made to a test file (
test_mini_agents_fix.py) to add a pytest import and usepytest.importorskip.
Changelog
Click here to see the changelog
- README.md
- Updated project description to reflect fork status and learning laboratory goal.
- Revised 'Key Features' section with links to new Portuguese documentation files.
- Minor rephrasing in 'Using Python Code' and 'Using No Code' sections.
- Added 'Setup for Local Development' section with installation instructions.
- docs/00_introducao/00_como_usar_esta_documentacao.md
- New file: Added documentation on how to use the documentation, including Obsidian tips (in Portuguese).
- docs/00_introducao/01_o_que_e_praisonai.md
- New file: Added introduction to PraisonAI, its features, and diagrams (in Portuguese).
- docs/00_introducao/02_filosofia_e_casos_de_uso.md
- New file: Added documentation on PraisonAI philosophy and use cases (in Portuguese).
- docs/00_introducao/03_metodologia_de_aprendizado.md
- New file: Added documentation on a recommended learning methodology (in Portuguese).
- docs/01_instalacao/00_instalacao_windows.md
- New file: Added detailed installation guide for Windows (in Portuguese).
- docs/02_conceitos_fundamentais/01_agentes.md
- New file: Added documentation on the fundamental concept of Agents (in Portuguese).
- docs/02_conceitos_fundamentais/02_tarefas.md
- New file: Added documentation on the fundamental concept of Tasks (in Portuguese).
- docs/02_conceitos_fundamentais/03_processos.md
- New file: Added documentation on the fundamental concept of Processes (in Portuguese).
- docs/02_conceitos_fundamentais/04_ferramentas.md
- New file: Added documentation on the fundamental concept of Tools (in Portuguese).
- docs/02_conceitos_fundamentais/05_memoria.md
- New file: Added documentation on the fundamental concept of Memory (in Portuguese).
- docs/02_conceitos_fundamentais/06_conhecimento_rag.md
- New file: Added documentation on Knowledge and RAG (in Portuguese).
- docs/03_usando_praisonai/01_usando_com_python.md
- New file: Added guide on using PraisonAI with Python (in Portuguese).
- docs/03_usando_praisonai/02_usando_com_yaml.md
- New file: Added guide on using PraisonAI with YAML (in Portuguese).
- docs/03_usando_praisonai/03_usando_com_js_ts.md
- New file: Added guide on using PraisonAI with JavaScript/TypeScript (in Portuguese).
- docs/03_usando_praisonai/04_criando_seu_primeiro_agente.md
- New file: Added quick guide to creating the first agent (in Portuguese).
- docs/03_usando_praisonai/05_modelos_de_agentes.md
- New file: Added overview of available agent models (in Portuguese).
- docs/03_usando_praisonai/06_configuracoes_yaml.md
- New file: Added YAML configuration reference (in Portuguese).
- docs/03_usando_praisonai/07_importes_e_funcoes_essenciais.md
- New file: Added essential Python imports and functions reference (in Portuguese).
- docs/04_workflows_avancados/01_processos_colaboracao_agentes.md
- New file: Added documentation on agent collaboration processes (in Portuguese).
- docs/04_workflows_avancados/02_workflow_roteamento_agentico.md
- New file: Added documentation on Agentic Routing workflow (in Portuguese).
- docs/04_workflows_avancados/03_workflow_orquestrador_trabalhador.md
- New file: Added documentation on Agentic Orchestrator-Worker workflow (in Portuguese).
- docs/04_workflows_avancados/04_workflow_autonomo_agentico.md
- New file: Added documentation on Agentic Autonomous workflow (in Portuguese).
- docs/04_workflows_avancados/05_paralelizacao_agentica.md
- New file: Added documentation on Agentic Parallelization workflow (in Portuguese).
- docs/04_workflows_avancados/06_encadeamento_prompts_agentico.md
- New file: Added documentation on Agentic Prompt Chaining workflow (in Portuguese).
- docs/04_workflows_avancados/07_avaliador_otimizador_agentico.md
- New file: Added documentation on Agentic Evaluator-Optimizer workflow (in Portuguese).
- docs/04_workflows_avancados/08_agentes_repetitivos.md
- New file: Added documentation on Repetitive Agents workflow (in Portuguese).
- docs/04_workflows_avancados/09_agentes_multimodais.md
- New file: Added brief documentation on Multimodal Agents (in Portuguese).
- docs/04_workflows_avancados/10_code_interpreter_agents.md
- New file: Added brief documentation on Code Interpreter Agents (in Portuguese).
- docs/04_workflows_avancados/11_math_agents.md
- New file: Added brief documentation on Math Agents (in Portuguese).
- docs/04_workflows_avancados/12_saida_estruturada.md
- New file: Added brief documentation on Structured Output (in Portuguese).
- docs/04_workflows_avancados/13_callback_agents.md
- New file: Added brief documentation on Callback Agents (in Portuguese).
- docs/04_workflows_avancados/14_mini_agents.md
- New file: Added brief documentation on Mini AI Agents (in Portuguese).
- docs/08_contribuindo_e_desenvolvimento/00_contribuindo_e_dev_local.md
- New file: Added guide on contributing and local development setup (in Portuguese).
- docs/08_contribuindo_e_desenvolvimento/01_estrutura_do_codigo.md
- New file: Added documentation on the code structure (in Portuguese).
- docs/09_duvidas_frequentes.md
- New file: Added Frequently Asked Questions (FAQ) section (in Portuguese).
- docs/README.md
- New file: Added English welcome message and course structure overview.
- docs/plan.md
- New file: Added content plan for the documentation (in Portuguese).
- docs_translations/pt-br/00_introducao/00_como_usar_esta_documentacao.md
- New file: Added documentation on how to use the documentation, including Obsidian tips (in Portuguese).
- docs_translations/pt-br/00_introducao/01_o_que_e_praisonai.md
- New file: Added introduction to PraisonAI, its features, and diagrams (in Portuguese).
- docs_translations/pt-br/00_introducao/02_filosofia_e_casos_de_uso.md
- New file: Added documentation on PraisonAI philosophy and use cases (in Portuguese).
- docs_translations/pt-br/00_introducao/03_metodologia_de_aprendizado.md
- New file: Added documentation on a recommended learning methodology (in Portuguese).
- docs_translations/pt-br/01_instalacao/00_instalacao_windows.md
- New file: Added detailed installation guide for Windows (in Portuguese).
- docs_translations/pt-br/02_conceitos_fundamentais/01_agentes.md
- New file: Added documentation on the fundamental concept of Agents (in Portuguese).
- docs_translations/pt-br/02_conceitos_fundamentais/02_tarefas.md
- New file: Added documentation on the fundamental concept of Tasks (in Portuguese).
- docs_translations/pt-br/02_conceitos_fundamentais/03_processos.md
- New file: Added documentation on the fundamental concept of Processes (in Portuguese).
- docs_translations/pt-br/02_conceitos_fundamentais/04_ferramentas.md
- New file: Added documentation on the fundamental concept of Tools (in Portuguese).
- docs_translations/pt-br/02_conceitos_fundamentais/05_memoria.md
- New file: Added documentation on the fundamental concept of Memory (in Portuguese).
- docs_translations/pt-br/02_conceitos_fundamentais/06_conhecimento_rag.md
- New file: Added documentation on Knowledge and RAG (in Portuguese).
- docs_translations/pt-br/03_usando_praisonai/01_usando_com_python.md
- New file: Added guide on using PraisonAI with Python (in Portuguese).
- docs_translations/pt-br/03_usando_praisonai/02_usando_com_yaml.md
- New file: Added guide on using PraisonAI with YAML (in Portuguese).
- docs_translations/pt-br/03_usando_praisonai/03_usando_com_js_ts.md
- New file: Added guide on using PraisonAI with JavaScript/TypeScript (in Portuguese).
- docs_translations/pt-br/03_usando_praisonai/04_criando_seu_primeiro_agente.md
- New file: Added quick guide to creating the first agent (in Portuguese).
- docs_translations/pt-br/03_usando_praisonai/05_modelos_de_agentes.md
- New file: Added overview of available agent models (in Portuguese).
- docs_translations/pt-br/03_usando_praisonai/06_configuracoes_yaml.md
- New file: Added YAML configuration reference (in Portuguese).
- docs_translations/pt-br/03_usando_praisonai/07_importes_e_funcoes_essenciais.md
- New file: Added essential Python imports and functions reference (in Portuguese).
- docs_translations/pt-br/04_workflows_avancados/01_processos_colaboracao_agentes.md
- New file: Added documentation on agent collaboration processes (in Portuguese).
- docs_translations/pt-br/04_workflows_avancados/02_workflow_roteamento_agentico.md
- New file: Added documentation on Agentic Routing workflow (in Portuguese).
- docs_translations/pt-br/04_workflows_avancados/03_workflow_orquestrador_trabalhador.md
- New file: Added documentation on Agentic Orchestrator-Worker workflow (in Portuguese).
- docs_translations/pt-br/04_workflows_avancados/04_workflow_autonomo_agentico.md
- New file: Added documentation on Agentic Autonomous workflow (in Portuguese).
- docs_translations/pt-br/04_workflows_avancados/05_paralelizacao_agentica.md
- New file: Added documentation on Agentic Parallelization workflow (in Portuguese).
- docs_translations/pt-br/04_workflows_avancados/06_encadeamento_prompts_agentico.md
- New file: Added documentation on Agentic Prompt Chaining workflow (in Portuguese).
- docs_translations/pt-br/04_workflows_avancados/07_avaliador_otimizador_agentico.md
- New file: Added documentation on Agentic Evaluator-Optimizer workflow (in Portuguese).
- docs_translations/pt-br/04_workflows_avancados/08_agentes_repetitivos.md
- New file: Added documentation on Repetitive Agents workflow (in Portuguese).
- docs_translations/pt-br/04_workflows_avancados/09_agentes_multimodais.md
- New file: Added brief documentation on Multimodal Agents (in Portuguese).
- docs_translations/pt-br/04_workflows_avancados/10_code_interpreter_agents.md
- New file: Added brief documentation on Code Interpreter Agents (in Portuguese).
- docs_translations/pt-br/04_workflows_avancados/11_math_agents.md
- New file: Added brief documentation on Math Agents (in Portuguese).
- docs_translations/pt-br/04_workflows_avancados/12_saida_estruturada.md
- New file: Added brief documentation on Structured Output (in Portuguese).
- docs_translations/pt-br/04_workflows_avancados/13_callback_agents.md
- New file: Added brief documentation on Callback Agents (in Portuguese).
- docs_translations/pt-br/04_workflows_avancados/14_mini_agents.md
- New file: Added brief documentation on Mini AI Agents (in Portuguese).
- docs_translations/pt-br/08_contribuindo_e_desenvolvimento/00_contribuindo_e_dev_local.md
- New file: Added guide on contributing and local development setup (in Portuguese).
- docs_translations/pt-br/08_contribuindo_e_desenvolvimento/01_estrutura_do_codigo.md
- New file: Added documentation on the code structure (in Portuguese).
- docs_translations/pt-br/09_duvidas_frequentes.md
- New file: Added Frequently Asked Questions (FAQ) section (in Portuguese).
- docs_translations/pt-br/plan.md
- New file: Added content plan for the documentation (in Portuguese).
- src/praisonai/tests/unit/agent/test_mini_agents_fix.py
- Added import for
pytest. - Used
pytest.importorskipto conditionally skip tests ifpraisonaiagentsis not available.
- Added import for
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨Explore these optional code suggestions:
|
|||||||||||||
There was a problem hiding this comment.
Code Review
This pull request introduces a massive amount of documentation for the PraisonAI framework, in both English (under docs/) and Portuguese (under docs_translations/pt-br/). The effort to structure and write this extensive documentation is commendable. The refactoring of the unit test in test_mini_agents_fix.py to use pytest.importorskip is also a good improvement.
However, there are several critical and high-severity issues that need attention before this PR can be considered complete, primarily concerning the state of the English documentation and consistency in repository references. Many files intended for the English documentation (docs/) are currently in Portuguese and marked with 'TODO: Translate this file to English'. This significantly impacts the completeness of the English documentation as described in the PR.
Additionally, there are some medium-severity concerns regarding potentially broken image links for logos and the consistency of links in the main README pointing to documentation versions.
Summary of Findings
- Incomplete English Documentation: Many files in the
docs/directory, intended for English documentation, are currently in Portuguese and marked with 'TODO: Translate this file to English'. This is a critical issue if the PR aims to deliver complete English documentation. - Incorrect Repository Links: The main README.md and some documentation files link to the original
MervinPraison/PraisonAIrepository for cloning or examples. For a fork intended as a separate learning laboratory, these should ideally point to theHabdel-Edenfield/PraisonAIrepository or its specific resources. - Logo Image Handling: Documentation notes indicate that logo images are not included and must be manually added by users, which will lead to broken images by default. Consider including placeholders or making instructions more prominent.
- README.md Key Feature Links: All 'Key Features' in the main README.md link to Portuguese (
pt-br) documentation. If English versions exist or are planned, linking to them from the English README would be more consistent. - README.md Formatting (YAML Configuration Link): The 'YAML Configuration' link in the main README.md (line 34, RIGHT side) is placed somewhat awkwardly within a centered
divbut outside the main documentation badge's<a>tag. This is a minor layout issue. (Not commented due to severity settings).
Merge Readiness
This pull request represents a significant contribution in terms of documentation. The sheer volume of new content is impressive, and the refactoring of the test file is a welcome improvement.
However, due to the critical issue of incomplete English translations (many 'English' documents are currently Portuguese placeholders with TODOs), and the high-severity issue of potentially confusing repository links, I cannot recommend merging this PR in its current state. These issues should be addressed to ensure the documentation is accurate, complete, and guides users effectively within the context of this specific fork.
I am unable to approve pull requests. Please ensure these changes are reviewed and approved by other maintainers after addressing the feedback, particularly the critical and high-severity items.
| @@ -0,0 +1,45 @@ | |||
| # TODO: Translate this file to English | |||
There was a problem hiding this comment.
This file, located in the docs/ directory (presumably for English documentation), starts with a 'TODO: Translate this file to English' and its content is in Portuguese. This pattern appears in many of the new files under docs/ (e.g., docs/00_introducao/01_o_que_e_praisonai.md, docs/02_conceitos_fundamentais/*, docs/03_usando_praisonai/*, etc.).
The PR description states it 'Adiciona extensa documentação em português e inglês'. If the English documentation largely consists of Portuguese text marked with TODOs, it means the English documentation is not yet complete. Could you clarify the status of the English translations? Are they planned for this PR or a follow-up? If they are intended for this PR, they need to be completed.
| PraisonAI is a fork of the original [MervinPraison/PraisonAI](https://github.com/MervinPraison/PraisonAI) project. | ||
| This edition is maintained by [Habdel-Edenfield](https://github.com/Habdel-Edenfield) and aims to be a **learning laboratory** for AI agent development. | ||
| Our goal is to provide clear examples and practical documentation for building multi‑agent systems. | ||
| The repository is under continuous development, with new features being added over time. |
There was a problem hiding this comment.
The README now correctly states this is a fork by Habdel-Edenfield. However, later in the 'Setup for Local Development' section (lines 560-564), the instruction is to clone https://github.com/MervinPraison/PraisonAI.git.
Shouldn't this point to the Habdel-Edenfield/PraisonAI repository to ensure developers are working with this specific fork, especially since it's positioned as a 'learning laboratory' distinct from the original?
| # Ou, se o agente tem tarefas explícitas (veremos em "Tarefas"): | ||
| # resultado = agente_roteirista.execute_task("Sua primeira tarefa aqui...") | ||
| ``` | ||
| > Veja o arquivo completo em: [examples/python/agents/single-agent.py](https://github.com/MervinPraison/PraisonAI/blob/main/examples/python/agents/single-agent.py) (link para o repositório original) |
There was a problem hiding this comment.
This documentation file (and others, e.g., in the 'Ferramentas' section) links to examples in the original MervinPraison/PraisonAI repository (e.g., [examples/python/agents/single-agent.py](https://github.com/MervinPraison/PraisonAI/blob/main/examples/python/agents/single-agent.py)).
Since this PR is for the Habdel-Edenfield fork, which is described as a 'learning laboratory', should these links point to examples within this fork? If the examples in the original repository are significantly different or if this fork plans to have its own tailored examples, linking to the original might cause confusion or direct users to code that doesn't align with this fork's specific learning objectives or modifications.
| - 🤖 **Automated Agent Creation** – [[Quick Guide]](docs/pt-br/03_usando_praisonai/04_criando_seu_primeiro_agente.md) | ||
| - 🔄 **Self‑Reflection Agents** – [[Evaluator/Optimizer]](docs/pt-br/04_workflows_avancados/07_avaliador_otimizador_agentico.md) | ||
| - 🧠 **Reasoning Agents** – [[Autonomous Workflows]](docs/pt-br/04_workflows_avancados/04_workflow_autonomo_agentico.md) | ||
| - 👁️ **Multimodal Agents** – [[Multimodal Agents]](docs/pt-br/04_workflows_avancados/09_agentes_multimodais.md) | ||
| - 🤝 **Multi‑Agent Collaboration** – [[Collaboration Processes]](docs/pt-br/04_workflows_avancados/01_processos_colaboracao_agentes.md) | ||
| - 🎭 **Agent Workflows** – [[Overview]](docs/pt-br/04_workflows_avancados/02_workflow_roteamento_agentico.md) | ||
| - 📚 **Add Custom Knowledge** – [[RAG Concepts]](docs/pt-br/02_conceitos_fundamentais/06_conhecimento_rag.md) | ||
| - 🧠 **Short- and Long‑Term Memory** – [[Memory Concepts]](docs/pt-br/02_conceitos_fundamentais/05_memoria.md) | ||
| - 📄 **Chat with PDFs** – [[RAG Concepts]](docs/pt-br/02_conceitos_fundamentais/06_conhecimento_rag.md#chat-with-pdf-agents) | ||
| - 💻 **Code Interpreter Agents** – [[Code Interpreter Agents]](docs/pt-br/04_workflows_avancados/10_code_interpreter_agents.md) | ||
| - 📚 **RAG Agents** – [[RAG Concepts]](docs/pt-br/02_conceitos_fundamentais/06_conhecimento_rag.md) | ||
| - 🤔 **Async & Parallel Processing** – [[Parallelization]](docs/pt-br/04_workflows_avancados/05_paralelizacao_agentica.md) | ||
| - 🔄 **Auto Agents** – [[Python Usage]](docs/pt-br/03_usando_praisonai/01_usando_com_python.md#explorando-mais-exemplos-python) | ||
| - 🔢 **Math Agents** – [[Math Agents]](docs/pt-br/04_workflows_avancados/11_math_agents.md) | ||
| - 🎯 **Structured Output** – [[Structured Output]](docs/pt-br/04_workflows_avancados/12_saida_estruturada.md) | ||
| - 🔗 **LangChain Integration** – [[Tools]](docs/pt-br/02_conceitos_fundamentais/04_ferramentas.md#conceito-fundamental-ferramentas-tools) | ||
| - 📞 **Callback Agents** – [[Callback Agents]](docs/pt-br/04_workflows_avancados/13_callback_agents.md) | ||
| - 🤏 **Mini Agents** – [[Mini Agents]](docs/pt-br/04_workflows_avancados/14_mini_agents.md) | ||
| - 🛠️ **100+ Custom Tools** – [[Tools]](docs/pt-br/02_conceitos_fundamentais/04_ferramentas.md) | ||
| - 📄 **YAML Configuration** – [[YAML Guide]](docs/pt-br/03_usando_praisonai/02_usando_com_yaml.md) | ||
| - 💯 **100+ LLM Support** – [[LLM Models]](docs/pt-br/06_modelos_llm/00_usando_diferentes_llms.md) |
There was a problem hiding this comment.
The 'Key Features' section now links each feature to a specific documentation page, which is a great improvement for navigation! However, all these links currently point to the Portuguese (pt-br) versions of the documentation (e.g., docs/pt-br/03_usando_praisonai/04_criando_seu_primeiro_agente.md).
Given that this PR aims to add extensive English documentation as well, would it be more appropriate for the main README.md (which is in English) to link to the English versions of these guides? Or perhaps provide parallel links if both are considered equally primary from the main README?
|
|
||
| Este arquivo serve como uma introdução geral ao PraisonAI. Nos próximos tópicos, detalharemos cada um desses recursos e conceitos. |
There was a problem hiding this comment.
The note about logos states: 'Os logos originais do PraisonAI (light/dark) não estão presentes neste repositório. Se desejar usá-los, você precisará baixá-los do repositório original... As referências de imagem neste arquivo foram ajustadas para ../recursos/logo_light.png e ../recursos/logo_dark.png.'
This implies that the logo images will be broken by default for users cloning this repository, as the recursos folder or the images themselves don't seem to be part of this PR.
Could we consider one of the following to improve user experience?
- Including placeholder images.
- Removing the
<picture>element for the logos if they cannot be provided directly. - Making the instruction to add them manually much more prominent, perhaps in the main README or a setup guide for the documentation.
1 participant
User description
/gemini summary
PR Type
Documentation, Tests
Description
Adiciona extensa documentação em português e inglês para o PraisonAI, cobrindo:
Refatora teste unitário para uso de
pytest.importorskip, melhorando a robustez e integração dos testes.Changes walkthrough 📝
40 files
02_usando_com_yaml.md
Adiciona documentação sobre uso do PraisonAI com YAML e CLIdocs/03_usando_praisonai/02_usando_com_yaml.md
arquivos YAML, incluindo exemplos, explicação dos campos, comandos da
CLI e dicas de execução.
tarefas, processos e variáveis globais.
não-programadores.
03_workflow_orquestrador_trabalhador.md
Documentação do padrão Orquestrador-Trabalhador Agêntico em workflowsdocs/04_workflows_avancados/03_workflow_orquestrador_trabalhador.md
Orquestrador-Trabalhador Agêntico.
desafios do padrão.
paralelos no PraisonAI.
06_encadeamento_prompts_agentico.md
Documentação sobre Encadeamento de Prompts Agêntico (Prompt Chaining)docs/04_workflows_avancados/06_encadeamento_prompts_agentico.md
Prompts Agêntico (Prompt Chaining).
vantagens e uso de gates.
prompts/agentes.
07_avaliador_otimizador_agentico.md
Documentação do padrão Avaliador-Otimizador Agêntico em workflowsdocs/04_workflows_avancados/07_avaliador_otimizador_agentico.md
(Evaluator Optimizer).
vantagens e desafios.
qualidade.
00_usando_diferentes_llms.md
Documentação sobre uso e configuração de múltiplos LLMs no PraisonAIdocs/06_modelos_llm/00_usando_diferentes_llms.md
no PraisonAI.
Gemini e outros.
considerações de compatibilidade e custos.
00_contribuindo_e_dev_local.md
Guia de contribuição e desenvolvimento local para PraisonAIdocs/08_contribuindo_e_desenvolvimento/00_contribuindo_e_dev_local.md
configurar ambiente de desenvolvimento local.
uso de ambientes virtuais e execução de testes.
02_usando_com_yaml.md
Tradução PT-BR: Uso do PraisonAI com YAML (No-Code)docs_translations/pt-br/03_usando_praisonai/02_usando_com_yaml.md
com YAML.
não-programadores.
01_processos_colaboracao_agentes.md
Tradução PT-BR: Processos de colaboração entre agentesdocs_translations/pt-br/04_workflows_avancados/01_processos_colaboracao_agentes.md
entre agentes (sequencial, hierárquico, workflow customizado).
03_workflow_orquestrador_trabalhador.md
Tradução PT-BR: Workflow Orquestrador-Trabalhador Agênticodocs_translations/pt-br/04_workflows_avancados/03_workflow_orquestrador_trabalhador.md
Agêntico.
06_encadeamento_prompts_agentico.md
Tradução PT-BR: Encadeamento de Prompts Agêntico (Prompt Chaining)docs_translations/pt-br/04_workflows_avancados/06_encadeamento_prompts_agentico.md
Agêntico.
de gates.
07_avaliador_otimizador_agentico.md
Tradução PT-BR: Avaliador-Otimizador Agêntico (Evaluator Optimizer)docs_translations/pt-br/04_workflows_avancados/07_avaliador_otimizador_agentico.md
Agêntico.
vantagens e desafios.
00_contribuindo_e_dev_local.md
Tradução PT-BR: Guia de contribuição e desenvolvimento localdocs_translations/pt-br/08_contribuindo_e_desenvolvimento/00_contribuindo_e_dev_local.md
desenvolvimento local.
dependências e execução de testes.
00_instalacao_windows.md
Guia completo de instalação do PraisonAI no Windowsdocs/01_instalacao/00_instalacao_windows.md
instalação via pip e via código-fonte.
problemas comuns.
03_processos.md
Documentação sobre processos de colaboração entre agentesdocs/02_conceitos_fundamentais/03_processos.md
multi-agente.
diagramas Mermaid.
01_usando_com_python.md
Guia de uso do PraisonAI com Python e exemplosdocs/03_usando_praisonai/01_usando_com_python.md
código.
PraisonAIAgents.
05_modelos_de_agentes.md
Catálogo de modelos de agentes de exemplo do PraisonAIdocs/03_usando_praisonai/05_modelos_de_agentes.md
PraisonAI.
04_workflow_autonomo_agentico.md
Documentação sobre workflows autônomos agênticos no PraisonAIdocs/04_workflows_avancados/04_workflow_autonomo_agentico.md
Workflow).
agentes autônomos.
00_visao_geral_ferramentas.md
Guia sobre ferramentas embutidas e personalizadas no PraisonAIdocs/05_ferramentas/00_visao_geral_ferramentas.md
PraisonAI.
criação de ferramentas personalizadas.
01_exemplo_analise_de_acoes.md
Exemplo prático de análise de ações com YAML e agentesdocs/07_exemplos_praticos/01_exemplo_analise_de_acoes.md
YAML e agentes PraisonAI.
00_instalacao_windows.md
Tradução: Guia de instalação do PraisonAI no Windows (pt-br)docs_translations/pt-br/01_instalacao/00_instalacao_windows.md
PraisonAI no Windows.
lusófono.
01_usando_com_python.md
Tradução: Guia de uso do PraisonAI com Python (pt-br)docs_translations/pt-br/03_usando_praisonai/01_usando_com_python.md
Python.
fluxo.
04_workflow_autonomo_agentico.md
Tradução: Workflow autônomo agêntico no PraisonAI (pt-br)docs_translations/pt-br/04_workflows_avancados/04_workflow_autonomo_agentico.md
autônomos agênticos.
00_visao_geral_ferramentas.md
Tradução: Visão geral de ferramentas no PraisonAI (pt-br)docs_translations/pt-br/05_ferramentas/00_visao_geral_ferramentas.md
PraisonAI.
ferramentas.
00_usando_diferentes_llms.md
Guia em português: Usando diferentes LLMs no PraisonAIdocs_translations/pt-br/06_modelos_llm/00_usando_diferentes_llms.md
diferentes LLMs no PraisonAI.
Gemini e outros.
01_exemplo_analise_de_acoes.md
Tradução: Exemplo prático de análise de ações (pt-br)docs_translations/pt-br/07_exemplos_praticos/01_exemplo_analise_de_acoes.md
ações com YAML e agentes.
01_o_que_e_praisonai.md
Adição de introdução e visão geral do PraisonAI com diagramasdocs/00_introducao/01_o_que_e_praisonai.md
framework, seus principais recursos e fluxos de agentes.
ferramentas e memória.
memória.
02_filosofia_e_casos_de_uso.md
Inclusão de filosofia do projeto e casos de uso PraisonAIdocs/00_introducao/02_filosofia_e_casos_de_uso.md
cenário.
06_conhecimento_rag.md
Adição de explicação detalhada sobre conhecimento e RAG em agentesdocs/02_conceitos_fundamentais/06_conhecimento_rag.md
(Retrieval Augmented Generation).
implementação no PraisonAI.
para agentes RAG.
PDF Agents".
05_paralelizacao_agentica.md
Adição de documentação sobre paralelização agêntica em workflowsdocs/04_workflows_avancados/05_paralelizacao_agentica.md
(Agentic Parallelization).
YAML.
recursos.
08_agentes_repetitivos.md
Adição de documentação sobre agentes repetitivos em workflowsavançadosdocs/04_workflows_avancados/08_agentes_repetitivos.md
Agents).
implementação em Python e YAML.
idempotência.
09_agentes_multimodais.md
Inclusão de documentação sobre agentes multimodais em workflowsdocs/04_workflows_avancados/09_agentes_multimodais.md
avançados.
computacional.
02_exemplo_geracao_artigos.md
Adição de exemplo prático de geração de artigos com YAMLdocs/07_exemplos_praticos/02_exemplo_geracao_artigos.md
execução teórica.
03_exemplo_analise_geracao_codigo.md
Inclusão de exemplo prático de análise e geração de código com YAMLdocs/07_exemplos_praticos/03_exemplo_analise_geracao_codigo.md
programação.
01_o_que_e_praisonai.md
Tradução da introdução e visão geral do PraisonAI para pt-brdocs_translations/pt-br/00_introducao/01_o_que_e_praisonai.md
ferramentas e memória.
03_processos.md
Adição de explicação sobre processos multi-agentes em pt-brdocs_translations/pt-br/02_conceitos_fundamentais/03_processos.md
multi-agentes.
com diagramas Mermaid.
PraisonAI.
06_conhecimento_rag.md
Tradução da documentação sobre conhecimento e RAG para pt-brdocs_translations/pt-br/02_conceitos_fundamentais/06_conhecimento_rag.md
implementação.
05_paralelizacao_agentica.md
Tradução da documentação sobre paralelização agêntica para pt-brdocs_translations/pt-br/04_workflows_avancados/05_paralelizacao_agentica.md
08_agentes_repetitivos.md
Tradução da documentação sobre agentes repetitivos para pt-brdocs_translations/pt-br/04_workflows_avancados/08_agentes_repetitivos.md
Python e YAML.
02_exemplo_geracao_artigos.md
Tradução do exemplo prático de geração de artigos para pt-brdocs_translations/pt-br/07_exemplos_praticos/02_exemplo_geracao_artigos.md
03_exemplo_analise_geracao_codigo.md
Tradução do exemplo prático de análise e geração de código para pt-brdocs_translations/pt-br/07_exemplos_praticos/03_exemplo_analise_geracao_codigo.md
com YAML.
programação.
1 files
test_mini_agents_fix.py
Refatoração da importação de dependências com pytest.importorskipsrc/praisonai/tests/unit/agent/test_mini_agents_fix.py
pytest.importorskipaoinvés de try/except manual.
45 files
Summary by CodeRabbit