RedPlanetHQ/core

Documentation: Claude API with Ollama embeddings + Railway deployment guide

Open

#129 opened on Oct 28, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (184 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (1,930 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Read the existing documentation files listed in the issue (docker.mdx, overview.mdx, environment variables.mdx, claude.mdx) and the provider implementation files (anthropic.ts, openai.ts). Understand the structure and style. Then draft the Claude + Ollama hybrid setup guide and Railway deployment steps. Ensure to include example environment variables and a troubleshooting section.
Tech stack
typescript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85