RedPlanetHQ/core

Documentation: Claude API with Ollama embeddings + Railway deployment guide

Aperta

#129 aperta il 28 ott 2025

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)TypeScript (184 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (1930 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Leggi i file di documentazione esistenti elencati nell'issue (docker.mdx, overview.mdx, environment variables.mdx, claude.mdx) e i file di implementazione del provider (anthropic.ts, openai.ts). Comprendi la struttura e lo stile. Poi redige la guida alla configurazione ibrida Claude + Ollama e i passaggi per il deploy su Railway. Assicurati di includere esempi di variabili d'ambiente e una sezione di risoluzione dei problemi.
Tech stack
typescript
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85