docs: add FAQ section#1776
Conversation
…ation, LLM providers, memory system, Agent Skills, AG-UI, A2A, and help resources
|
I have read the CLA Document and I hereby sign the CLA You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot. |
📝 WalkthroughChange OverviewThis PR adds a comprehensive FAQ section to the README.md file, containing 10 frequently asked questions designed to help users quickly understand tRPC-Agent-Go's capabilities and key differentiators. The new section covers:
Scope: 69 lines of documentation content added to README.md. No code changes, no new exported entities, no behavioral modifications. Compatibility and Behavioral RisksRisk Level: None
Recommended Validation Steps
中文变更概览本PR向README.md文件添加了一个全面的FAQ（常见问题）部分，包含10个常见问题，旨在帮助用户快速理解tRPC-Agent-Go的功能和核心差异。新增章节涵盖：
范围：向README.md添加了69行文档内容。无代码变更，无新导出实体，无行为修改。 兼容性和行为风险风险等级：无
推荐验证步骤
WalkthroughREADME.md receives a new FAQ section addressing core user questions: what tRPC-Agent-Go is, how it differs from LangChain, GraphAgent purpose, installation via ChangesFAQ Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 737-805: The README.zh_CN.md is missing the FAQ section present in
README.md (the block from the "## FAQ" heading through the "How do I get help?"
item); add a translated Chinese version of that entire FAQ block into
README.zh_CN.md, preserving the same structure (## FAQ and the same question
headings such as "What is tRPC-Agent-Go?", "How does tRPC-Agent-Go differ from
LangChain?", "How do I install tRPC-Agent-Go?", "What LLM providers are
supported?", "What is the memory system?", "What are Agent Skills?", "What is
AG-UI?", "What is A2A?", and "How do I get help?") and translate the content and
links appropriately, and update any table of contents or index in
README.zh_CN.md if one exists to include the new FAQ section.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ## FAQ | ||
|
|
||
| ### What is tRPC-Agent-Go? | ||
|
|
||
| tRPC-Agent-Go is a powerful Go framework for building intelligent agent systems. It transforms how you create AI applications by providing autonomous agents that think, remember, collaborate, and act with unprecedented ease. | ||
|
|
||
| ### How does tRPC-Agent-Go differ from LangChain? | ||
|
|
||
| - **tRPC-Agent-Go**: Go-native framework, high performance, production-ready with telemetry/tracing, GraphAgent (type-safe workflows), Agent Skills (SKILL.md), built-in memory service | ||
| - **LangChain**: Python-first, broader ecosystem, more third-party integrations | ||
|
|
||
| ### What is GraphAgent? | ||
|
|
||
| GraphAgent provides type-safe graph workflows with multi-conditional routing, functionally equivalent to LangGraph but for Go: | ||
| - Chain-based workflows | ||
| - Parallel execution | ||
| - Conditional routing | ||
| - Type-safe state management | ||
|
|
||
| ### How do I install tRPC-Agent-Go? | ||
|
|
||
| ```bash | ||
| go get trpc.group/trpc-go/trpc-agent-go | ||
| ``` | ||
|
|
||
| ### What LLM providers are supported? | ||
|
|
||
| tRPC-Agent-Go supports multiple LLM providers: | ||
| - OpenAI | ||
| - Anthropic | ||
| - Azure OpenAI | ||
| - Local models | ||
| - Custom providers via model interface | ||
|
|
||
| ### What is the memory system? | ||
|
|
||
| The memory system provides: | ||
| - Persistent memory with search | ||
| - Long-term state management | ||
| - Contextual awareness across sessions | ||
| - Memory service managed at runner level | ||
|
|
||
| ### What are Agent Skills? | ||
|
|
||
| Agent Skills are reusable workflows defined in `SKILL.md` files: | ||
| - Safe execution environment | ||
| - Reusable across agents | ||
| - Human-readable workflow definitions | ||
|
|
||
| ### What is AG-UI? | ||
|
|
||
| AG-UI (Agent-User Interaction) provides: | ||
| - UI integration for agents | ||
| - User interaction capabilities | ||
| - Visual workflow management | ||
|
|
||
| ### What is A2A? | ||
|
|
||
| A2A (Agent-to-Agent) provides: | ||
| - Agent interoperability | ||
| - Communication between agents | ||
| - Multi-agent collaboration protocols | ||
|
|
||
| ### How do I get help? | ||
|
|
||
| - **Documentation**: https://trpc-group.github.io/trpc-agent-go/ | ||
| - **Go Reference**: https://pkg.go.dev/trpc.group/trpc-go/trpc-agent-go | ||
| - **GitHub Issues**: https://github.com/trpc-group/trpc-agent-go/issues | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Check if README.zh_CN.md exists and contains FAQ section
# Check if Chinese README exists
if [ -f "README.zh_CN.md" ]; then
echo "=== README.zh_CN.md found ==="
# Search for FAQ section
echo "=== Checking for FAQ section ==="
rg -n "FAQ|常见问题" README.zh_CN.md || echo "No FAQ section found"
# Count lines to see if it was updated
wc -l README.zh_CN.md
else
echo "README.zh_CN.md not found"
fiRepository: trpc-group/trpc-agent-go
Length of output: 172
Add FAQ section to README.zh_CN.md for consistency with README.md.
The FAQ section (lines 737-805 in README.md) is missing from README.zh_CN.md. Since the repository maintains bilingual documentation, this section should be translated and added to the Chinese version to keep both versions consistent.
中文
向 README.zh_CN.md 添加 FAQ 部分以与 README.md 保持一致。
README.md 中的 FAQ 部分（第 737-805 行）在 README.zh_CN.md 中缺失。由于仓库维护双语文档，此部分应翻译后添加到中文版本，保持两个版本的一致性。
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 737 - 805, The README.zh_CN.md is missing the FAQ
section present in README.md (the block from the "## FAQ" heading through the
"How do I get help?" item); add a translated Chinese version of that entire FAQ
block into README.zh_CN.md, preserving the same structure (## FAQ and the same
question headings such as "What is tRPC-Agent-Go?", "How does tRPC-Agent-Go
differ from LangChain?", "How do I install tRPC-Agent-Go?", "What LLM providers
are supported?", "What is the memory system?", "What are Agent Skills?", "What
is AG-UI?", "What is A2A?", and "How do I get help?") and translate the content
and links appropriately, and update any table of contents or index in
README.zh_CN.md if one exists to include the new FAQ section.
1 participant
Adds a comprehensive FAQ section to help users quickly understand tRPC-Agent-Go:
This FAQ aims to reduce user confusion and improve the onboarding experience for Go developers.