amiable-templates

A unified documentation portal for Railway deployment templates.

What is This?

amiable-templates is an open source documentation site that aggregates Railway deployment templates from multiple repositories into a single, searchable portal. It provides:

• Template Grid - Browse available templates with descriptions, features, and deploy links
• Quick Start Guide - Get deploying in minutes
• Cross-Project Documentation - Aggregated docs from template source repositories
• Architecture Decision Records - Transparent decision-making process

Quick Start

View the Site

Visit amiable.dev/templates (or your deployed URL).

Local Development

# Clone the repository
git clone https://github.com/amiable-dev/amiable-templates.git
cd amiable-templates

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Aggregate template docs (requires GITHUB_TOKEN)
export GITHUB_TOKEN=ghp_your_token_here
python scripts/aggregate_templates.py

# Serve locally
mkdocs serve

The site will be available at http://127.0.0.1:8000.

Available Templates

Template	Description	Category
LiteLLM + Langfuse Starter	Production-ready LLM gateway with observability	Observability
LiteLLM + Langfuse Production	Enterprise-grade LLM proxy with backups and monitoring	Observability
LLM Council	Multi-model consensus system for AI decision-making	AI Infrastructure

See templates.yaml for the full template registry.

Project Structure

amiable-templates/
├── docs/                    # MkDocs source
│   ├── index.md            # Home page
│   ├── quickstart.md       # Quick Start guide
│   ├── templates/          # Template documentation (aggregated)
│   ├── adrs/               # Architecture Decision Records
│   └── stylesheets/        # Custom CSS
├── scripts/
│   └── aggregate_templates.py  # Doc aggregation script
├── templates.yaml          # Template registry
├── templates.schema.yaml   # Configuration schema
├── mkdocs.yml              # MkDocs configuration
└── .github/workflows/      # CI/CD pipelines

Configuration

Templates are defined in templates.yaml:

templates:
  - id: litellm-langfuse-starter
    repo:
      owner: "amiable-dev"
      name: "litellm-langfuse-railway"
    title: "LiteLLM + Langfuse Starter"
    description: "Production-ready LLM gateway with observability"
    category: observability
    directories:
      docs:
        - path: "starter/README.md"
          target: "overview.md"

See the Template Configuration ADR for details.

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Adding a Template

1. Fork this repository
2. Add your template to templates.yaml
3. Submit a pull request

Template requirements:

• Publicly accessible GitHub repository
• Clear documentation in the repository
• Working Railway deployment

Development Setup

# Install pre-commit hooks (recommended)
pip install pre-commit
pre-commit install

Architecture Decisions

This project uses Architecture Decision Records (ADRs) to document significant decisions:

ADR	Title
ADR-001	Project Structure & OSS Standards
ADR-002	MkDocs Site Architecture
ADR-003	Template Configuration System
ADR-004	CI/CD & Deployment
ADR-005	DevSecOps Implementation
ADR-006	Cross-Project Documentation Aggregation

ADRs are reviewed by the LLM Council for multi-model architectural feedback.

Security

• Secret scanning via Gitleaks (pre-commit + CI)
• Dependency updates via Dependabot
• Fork-friendly CI (no secrets required for PR checks)

See SECURITY.md for vulnerability reporting.

License

MIT License - see LICENSE for details.

Related Projects

• litellm-langfuse-railway - LLM gateway templates
• llm-council - Multi-model consensus system