RedPlanetHQ/core

Documentation: Claude API with Ollama embeddings + Railway deployment guide

Offen

#129 geöffnet am 28.10.2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (184 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (1.930 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Lesen Sie die in der Ausgabe aufgeführten vorhandenen Dokumentationsdateien (docker.mdx, overview.mdx, environment variables.mdx, claude.mdx) und die Provider Implementierungsdateien (anthropic.ts, openai.ts). Verstehen Sie die Struktur und den Stil. Verfassen Sie dann die Anleitung zur hybriden Einrichtung von Claude + Ollama und die Schritte zur Bereitstellung auf Railway. Stellen Sie sicher, dass Sie Beispielumgebungsvariablen und einen Abschnitt zur Fehlerbehebung einfügen.
Tech Stack
typescript
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85