docs: add CI badges, CONTRIBUTING guide and OCI image labels

Author: albegosu

CONTRIBUTING.md

@@ -0,0 +1,100 @@
+# Contributing to From Zero RAG
+
+Thanks for your interest in contributing! This is primarily a learning project, but improvements, bug fixes and ideas are welcome.
+
+## Getting Started
+
+### Prerequisites
+
+- [Node.js 20+](https://nodejs.org/)
+- [pnpm 10+](https://pnpm.io/) — `npm install -g pnpm`
+- [Docker + Docker Compose](https://docs.docker.com/get-docker/)
+- An Ollama instance or API key for Google/OpenAI embeddings
+
+### Local Setup
+
+```bash
+# 1. Clone the repo
+git clone https://github.com/albegosu/from-zero-rag.git
+cd from-zero-rag
+
+# 2. Install dependencies (all workspace packages)
+pnpm install
+
+# 3. Start the backend services (DB + Ollama)
+docker compose --profile api up -d
+
+# 4. Set up environment for the API
+cp rag-api/.env.example rag-api/.env
+# Edit rag-api/.env with your settings
+
+# 5. Run database migrations
+cd rag-api && npx prisma migrate dev && cd ..
+
+# 6. Start everything in dev mode
+pnpm dev
+```
+
+## Project Structure
+
+```
+from-zero-rag/
+├── rag-api/              # NestJS backend (RAG pipeline, vector search)
+├── rag-ui/               # Nuxt 3 frontend (chat, document management)
+├── packages/
+│   ├── rag-learning/     # Shared challenge/validator library
+│   └── rag-playground/   # Interactive learning UI
+└── docker-compose.yml    # Full stack orchestration
+```
+
+## Development Workflow
+
+1. **Fork** the repository
+2. **Create a branch** from `main`: `git checkout -b feat/your-feature`
+3. **Make your changes** and add tests if applicable
+4. **Run the checks** before pushing:
+
+```bash
+# Backend tests
+cd rag-api && pnpm test
+
+# Backend lint
+cd rag-api && pnpm lint
+
+# Learning package build
+pnpm --filter @rag/learning build
+```
+
+5. **Open a pull request** against `main` — CI will run automatically
+
+## Branch Naming
+
+| Type | Pattern | Example |
+|------|---------|---------|
+| Feature | `feat/short-description` | `feat/streaming-responses` |
+| Bug fix | `fix/short-description` | `fix/chunking-offset` |
+| Docs | `docs/short-description` | `docs/api-endpoints` |
+| Chore | `chore/short-description` | `chore/update-deps` |
+
+## Commit Style
+
+Follow [Conventional Commits](https://www.conventionalcommits.org/):
+
+```
+feat: add streaming support for chat responses
+fix: correct chunk offset calculation for unicode text
+docs: add deployment guide for Railway
+chore: update pnpm lockfile
+```
+
+## What to Contribute
+
+- **Bug fixes** — especially around chunking accuracy, embedding edge cases
+- **New validators** for the learning playground challenges
+- **Documentation** improvements and clarifications
+- **Tests** — the backend test coverage can always grow
+- **UI/UX** improvements for the chat or document management views
+
+## Questions?
+
+Open an [issue](https://github.com/albegosu/from-zero-rag/issues) with your question or idea before starting large changes — it helps align effort.

README.md

@@ -2,10 +2,17 @@
 
 A production-ready full-stack application for AI-powered **Retrieval-Augmented Generation (RAG)**. Built to demonstrate modern RAG architecture, vector databases, and cloud-native deployment.
 
+[![CI Backend](https://github.com/albegosu/from-zero-rag/actions/workflows/test-backend.yml/badge.svg)](https://github.com/albegosu/from-zero-rag/actions/workflows/test-backend.yml)
+[![CI Frontend](https://github.com/albegosu/from-zero-rag/actions/workflows/test-frontend.yml/badge.svg)](https://github.com/albegosu/from-zero-rag/actions/workflows/test-frontend.yml)
+[![CI Learning](https://github.com/albegosu/from-zero-rag/actions/workflows/test-learning.yml/badge.svg)](https://github.com/albegosu/from-zero-rag/actions/workflows/test-learning.yml)
+[![Docker Build](https://github.com/albegosu/from-zero-rag/actions/workflows/docker-build.yml/badge.svg)](https://github.com/albegosu/from-zero-rag/actions/workflows/docker-build.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node.js](https://img.shields.io/badge/Node.js-20-brightgreen)](https://nodejs.org/)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue)](https://www.typescriptlang.org/)
 [![NestJS](https://img.shields.io/badge/NestJS-10.3-red)](https://nestjs.com/)
 [![Nuxt](https://img.shields.io/badge/Nuxt-3-green)](https://nuxt.com/)
 [![pgvector](https://img.shields.io/badge/pgvector-0.5-purple)](https://github.com/pgvector/pgvector)
+[![pnpm](https://img.shields.io/badge/pnpm-workspace-orange)](https://pnpm.io/)
 
 ---
 

rag-api/Dockerfile

@@ -22,6 +22,11 @@ FROM node:20-alpine AS runner
 RUN apk add --no-cache libc6-compat openssl curl
 WORKDIR /app
 
+LABEL org.opencontainers.image.title="from-zero-rag backend" \
+      org.opencontainers.image.description="NestJS RAG API — document ingestion, vector search, embeddings and chat with pgvector + Ollama" \
+      org.opencontainers.image.source="https://github.com/albegosu/from-zero-rag" \
+      org.opencontainers.image.licenses="MIT"
+
 ENV NODE_ENV=production
 
 # Install Prisma CLI for migrations

rag-ui/Dockerfile

@@ -21,6 +21,11 @@ RUN npm run build
 FROM node:20-alpine AS runner
 WORKDIR /app
 
+LABEL org.opencontainers.image.title="from-zero-rag frontend" \
+      org.opencontainers.image.description="Nuxt 3 UI — chat interface, document management and RAG search for from-zero-rag" \
+      org.opencontainers.image.source="https://github.com/albegosu/from-zero-rag" \
+      org.opencontainers.image.licenses="MIT"
+
 ENV NODE_ENV=production
 
 # Copy built files