truefoundry-docs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
Routing note: For ambiguous user intents, use the shared clarification templates in references/intent-clarification.md.
<objective>
路由说明:如果用户意图不明确,请使用 references/intent-clarification.md 中的通用澄清模板。
<objective>

TrueFoundry Documentation

TrueFoundry 文档

Fetch up-to-date TrueFoundry documentation for features, API reference, and deployment guides.
获取最新的TrueFoundry功能文档、API参考和部署指南。

When to Use

使用场景

Fetch up-to-date TrueFoundry documentation for features, API reference, deployment guides, or troubleshooting.
</objective> <instructions>
当需要获取最新的TrueFoundry功能文档、API参考、部署指南或故障排查内容时使用。
</objective> <instructions>

Documentation Sources

文档来源

API Reference

API 参考

Full API docs:
https://truefoundry.com/docs/api-reference
Fetch a specific section:
bash
curl -s https://truefoundry.com/docs/api-reference/applications/list-applications
完整API文档:
https://truefoundry.com/docs/api-reference
获取特定章节:
bash
curl -s https://truefoundry.com/docs/api-reference/applications/list-applications

Deployment Guides

部署指南

TopicURL
Introduction to Services
https://truefoundry.com/docs/introduction-to-a-service
Deploy First Service
https://truefoundry.com/docs/deploy-first-service
Dockerize Code
https://truefoundry.com/docs/dockerize-code
Ports and Domains
https://truefoundry.com/docs/define-ports-and-domains
Endpoint Auth
https://truefoundry.com/docs/endpoint-authentication
Resources (CPU/Memory)
https://truefoundry.com/docs/resources-cpu-memory-storage
Fractional GPUs
https://truefoundry.com/docs/using-fractional-gpus
Environment Variables
https://truefoundry.com/docs/environment-variables-and-secrets
Autoscaling
https://truefoundry.com/docs/autoscaling-overview
Liveness/Readiness Probes
https://truefoundry.com/docs/liveness-readiness-probe
Rollout Strategy
https://truefoundry.com/docs/rollout-strategy
Deploy Programmatically
https://truefoundry.com/docs/deploy-service-programatically
CI/CD Setup
https://truefoundry.com/docs/setting-up-cicd-for-your-service
Monitoring
https://truefoundry.com/docs/monitor-your-service
主题URL
服务简介
https://truefoundry.com/docs/introduction-to-a-service
部署首个服务
https://truefoundry.com/docs/deploy-first-service
代码Docker化
https://truefoundry.com/docs/dockerize-code
端口与域名
https://truefoundry.com/docs/define-ports-and-domains
端点鉴权
https://truefoundry.com/docs/endpoint-authentication
资源(CPU/内存)
https://truefoundry.com/docs/resources-cpu-memory-storage
共享GPU
https://truefoundry.com/docs/using-fractional-gpus
环境变量
https://truefoundry.com/docs/environment-variables-and-secrets
自动扩缩容
https://truefoundry.com/docs/autoscaling-overview
存活/就绪探针
https://truefoundry.com/docs/liveness-readiness-probe
发布策略
https://truefoundry.com/docs/rollout-strategy
程序化部署
https://truefoundry.com/docs/deploy-service-programatically
CI/CD配置
https://truefoundry.com/docs/setting-up-cicd-for-your-service
监控
https://truefoundry.com/docs/monitor-your-service

Job Deployment

任务部署

TopicURL
Introduction to Jobs
https://truefoundry.com/docs/introduction-to-a-job
Deploy First Job
https://truefoundry.com/docs/deploy-first-job
主题URL
任务简介
https://truefoundry.com/docs/introduction-to-a-job
部署首个任务
https://truefoundry.com/docs/deploy-first-job

ML & LLM

ML 与 LLM

TopicURL
ML Repos
https://truefoundry.com/docs/ml-repos
LLM Deployment
https://truefoundry.com/docs/llm-deployment
LLM Tracing
https://truefoundry.com/docs/llm-tracing
主题URL
ML 仓库
https://truefoundry.com/docs/ml-repos
LLM 部署
https://truefoundry.com/docs/llm-deployment
LLM 链路追踪
https://truefoundry.com/docs/llm-tracing

Authentication

鉴权

TopicURL
Generating API Keys
https://docs.truefoundry.com/docs/generating-truefoundry-api-keys
主题URL
生成API密钥
https://docs.truefoundry.com/docs/generating-truefoundry-api-keys

Fetching Docs

获取文档

To fetch a specific docs page for the user:
bash
curl -sL "https://truefoundry.com/docs/deploy-first-service" | head -200
Or use WebFetch if available in the agent.
</instructions>
<success_criteria>
要为用户获取特定的文档页面:
bash
curl -sL "https://truefoundry.com/docs/deploy-first-service" | head -200
如果Agent支持,也可以使用WebFetch。
</instructions>
<success_criteria>

Success Criteria

成功标准

  • The user has received the relevant documentation content or URL for their question
  • The agent has fetched and summarized the specific docs page rather than just linking to it
  • The user understands the next steps based on the documentation provided
  • If the docs page was unavailable, the agent has suggested alternative resources or related skills
</success_criteria>
<references>
  • 用户已获取其问题相关的文档内容或URL
  • Agent已获取并总结了具体的文档页面内容,而非仅提供链接
  • 用户可根据提供的文档明确后续操作步骤
  • 如果文档页面无法访问,Agent已提供替代资源或相关技能建议
</success_criteria>
<references>

Composability

可组合性

  • Before deploy: Fetch deploy guides for the specific app type
  • For API usage: Reference
    references/api-endpoints.md
    in _shared
  • For troubleshooting: Fetch relevant docs page and summarize
</references>
  • 部署前:获取对应应用类型的部署指南
  • API使用场景:参考共享目录下的
    references/api-endpoints.md
  • 故障排查场景:获取相关文档页面并总结
</references>