RedPlanetHQ / RedPlanetHQ/core
Documentation: Claude API with Ollama embeddings + Railway deployment guide
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2k
- Forks
- 194
- Avg merge
- 12m
- Merged PRs (30d)
- 2
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 overviewdocs/self-hosting/environment-variables.mdx- Environment variable configurationdocs/providers/claude.mdx- Claude provider documentationREADME.md- Main README with deployment options
Provider Configuration
apps/webapp/app/lib/batch/providers/anthropic.ts- Anthropic/Claude provider implementationapps/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
- The Railway deployment template may need updates to include Ollama service
- Check existing environment variable patterns in
environment-variables.mdx - Follow the documentation style in existing provider docs
- Consider adding a diagram showing the hybrid architecture
Labels
good first issue, documentation
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read docs/self-hosting/docker.mdx, overview.mdx, environment-variables.mdx, and docs/providers/claude.mdx first, then inspect the Anthropic and OpenAI provider implementations for configuration patterns. Done means the docs explain Claude chat/inference, Ollama embeddings, hybrid environment variables, Railway deployment, and troubleshooting, with any required template updates and an optional architecture diagram covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ollama, typescript
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100