Skip to content

docs: enhance .env.example with API links and configuration guidance#1

Open
penguin-sy wants to merge 1 commit intomainfrom
docs/enhance-env-example
Open

docs: enhance .env.example with API links and configuration guidance#1
penguin-sy wants to merge 1 commit intomainfrom
docs/enhance-env-example

Conversation

@penguin-sy
Copy link
Copy Markdown
Collaborator

改进说明

此 PR 增强 .env.example 文件的文档说明,帮助用户更快配置环境。

主要改进:

  1. 一键直达链接:添加获取各类 API 密钥的直接链接

  2. 多密钥策略解释:说明为什么需要多个 API 密钥

    防止单一密钥的并发限制(429)影响所有功能。

  3. 免费额度透明:明确标注 Jina AI 和 Firecrawl 的免费额度

    • Jina AI: 2000次/月
    • Firecrawl: 100页/月
  4. 格式提示:明确密钥格式

    • jina_ 前缀是 Jina AI 的标准格式
    • 模型名称示例:SiliconFlow 格式 "Pro/deepseek-ai/DeepSeek-V3.2"
  5. 工具分类说明:为外部工具添加功能标签

    • Brave Search API (搜索)
    • Perplexity API (联网搜索)
    • ElevenLabs (语音合成)
    • Deepgram (语音识别)

影响:

  • 向后兼容:所有现有配置保持不变
  • 用户友好:降低新用户配置难度
  • 透明成本:帮助用户了解免费资源和可能成本

提交信息:

docs: enhance .env.example with API links and configuration guidance


测试建议:验证所有链接有效,确保新增的中文注释不影响英语用户的正常使用。

- Add direct links to obtain API keys (SiliconFlow, DeepSeek, Jina AI, Firecrawl)
- Explain multi-key strategy for avoiding rate limits
- Include free tier quotas for Jina AI (2000/month) and Firecrawl (100 pages/month)
- Add model name examples in SiliconFlow format
- Improve Chinese comments for better clarity
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant