RedPlanetHQ/core

Documentation: Claude API with Ollama embeddings + Railway deployment guide

开放

#129 创建于 2025年10月28日

 (0 条评论) (0 个反应) (0 位负责人)TypeScript (184 个派生)auto 404
documentationgood first issue

仓库指标

星标
 (1,930 个星标)
PR 合并指标
 (平均合并 3小时 2分钟) (30 天内合并 10 个 PR)

描述

Description

Add comprehensive documentation on how to use Claude API alongside Ollama embedding models, plus a Railway deployment guide with Ollama support.

Files to Look At

Documentation

  • docs/self-hosting/docker.mdx - Current Docker deployment docs (Railway button already added)
  • docs/self-hosting/overview.mdx - Self-hosting overview
  • docs/self-hosting/environment-variables.mdx - Environment variable configuration
  • docs/providers/claude.mdx - Claude provider documentation
  • README.md - Main README with deployment options

Provider Configuration

  • apps/webapp/app/lib/batch/providers/anthropic.ts - Anthropic/Claude provider implementation
  • apps/webapp/app/lib/batch/providers/openai.ts - OpenAI provider for reference

Tasks

  • Document how to configure Claude API key for chat/inference
  • Document how to configure Ollama for embeddings only
  • Add example environment variables for hybrid setup
  • Create Railway deployment guide with Ollama service configuration
  • Add troubleshooting section for common issues

Guidelines

  1. The Railway deployment template may need updates to include Ollama service
  2. Check existing environment variable patterns in environment-variables.mdx
  3. Follow the documentation style in existing provider docs
  4. Consider adding a diagram showing the hybrid architecture

Labels

good first issue, documentation

贡献者指南