Files

tegwick 2f0e0cbedb docs: add SCOPE.md for rapid orientation

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

2026-03-17 23:11:38 +01:00

2.5 KiB

Raw Blame History

SCOPE

This file helps you quickly understand what this repository is about, when it is relevant, and when it is not. It is intentionally lightweight and may be incomplete.

One-liner

S4 Developer Enablement layer of the Railiance OAS Stack — owns CI/CD pipelines, developer portal, platform templates, SDKs, and buildpacks.

Core Idea

Railiance is structured as five independent repos per OAS Stack layer. This repo is S4 — the tools that allow the system to evolve. S4 depends on the platform (S3) being operational before any tooling can use platform services, and in turn S5 (applications) uses S4's CI/CD pipelines and deployment templates.

In Scope

CI/CD pipelines and automation tooling
Developer portal (self-service deployment interface)
Platform deployment templates for workloads
SDKs and libraries for platform consumers
Buildpacks and image builders

Out of Scope (per ADR-003)

OS-level concerns → railiance-infra (S1)
Kubernetes runtime → railiance-cluster (S2)
Platform services → railiance-platform (S3)
Application deployments → railiance-apps (S5)
No re-configuration of lower layers from this repo

Relevant When

Setting up CI/CD for the Railiance stack
Creating or modifying developer tools and deployment templates
S3 is operational and tooling layer can now be built

Not Relevant When

S3 (platform services) is not yet operational (pre-condition not met)
Infrastructure, cluster, or platform work needed (wrong layer)

Current State

Status: experimental (placeholder; no active work)
Implementation: empty (workplans/ has only .gitkeep; no CI/CD content yet)
Stability: n/a
Usage: will be developed after railiance-platform (S3) baseline is established

How It Fits

Upstream dependencies: railiance-platform (S3) must be operational
Downstream consumers: railiance-apps (S5) uses CI/CD and templates from this layer
Often used with: railiance-platform (S3), railiance-apps (S5)

Terminology

Preferred terms: OAS Stack Level S4, developer enablement, boundary rule

railiance-platform (S3) — pre-condition; provides services that S4 tooling depends on
railiance-apps (S5) — consumer of S4 CI/CD and templates

Getting Oriented

Start with: CLAUDE.md (session protocol, OAS boundary rules)
Key files / directories: workplans/ (empty), Makefile
Pre-conditions: railiance-platform (S3) must be operational

2.5 KiB Raw Blame History