From 2a97122095ad28558367819bada16c13d8646654 Mon Sep 17 00:00:00 2001 From: cyanghxst <155308268+cyanghxst@users.noreply.github.com> Date: Sun, 5 Apr 2026 06:11:43 -0700 Subject: [PATCH] Move markdown files to docs and update links --- AI_USAGE.md => docs/AI_USAGE.md | 0 DECISION_LOG.md => docs/DECISION_LOG.md | 0 README.md => docs/README.md | 6 +++--- {goals => docs/goals}/Documentation.md | 0 {goals => docs/goals}/EndpointsSpec.md | 0 {goals => docs/goals}/IncidentResponse.md | 0 {goals => docs/goals}/ReliabilityEngineering.md | 0 {goals => docs/goals}/ScalabilityEngineering.md | 0 8 files changed, 3 insertions(+), 3 deletions(-) rename AI_USAGE.md => docs/AI_USAGE.md (100%) rename DECISION_LOG.md => docs/DECISION_LOG.md (100%) rename README.md => docs/README.md (98%) rename {goals => docs/goals}/Documentation.md (100%) rename {goals => docs/goals}/EndpointsSpec.md (100%) rename {goals => docs/goals}/IncidentResponse.md (100%) rename {goals => docs/goals}/ReliabilityEngineering.md (100%) rename {goals => docs/goals}/ScalabilityEngineering.md (100%) diff --git a/AI_USAGE.md b/docs/AI_USAGE.md similarity index 100% rename from AI_USAGE.md rename to docs/AI_USAGE.md diff --git a/DECISION_LOG.md b/docs/DECISION_LOG.md similarity index 100% rename from DECISION_LOG.md rename to docs/DECISION_LOG.md diff --git a/README.md b/docs/README.md similarity index 98% rename from README.md rename to docs/README.md index ba36a35..1041a9c 100644 --- a/README.md +++ b/docs/README.md @@ -24,8 +24,8 @@ A resilient URL shortener service built for production. - [Monitoring & Observability](#monitoring--observability) - [Deployment](#deployment) - [AI Usage](AI_USAGE.md) -- [Architecture](/docs/ARCHITECTURE.md) -- [Decision Log](/DECISION_LOG.md) +- [Architecture](ARCHITECTURE.md) +- [Decision Log](DECISION_LOG.md) - [License](#license) ## Prerequisites @@ -271,7 +271,7 @@ Pre-configured dashboard includes: request rate by HTTP method, p99 latency, err ### Kubernetes (production) -See [docs/k8s-setup.md](docs/k8s-setup.md) for the full K3s cluster setup guide. +See [k8s-setup.md](k8s-setup.md) for the full K3s cluster setup guide. **Deploy** diff --git a/goals/Documentation.md b/docs/goals/Documentation.md similarity index 100% rename from goals/Documentation.md rename to docs/goals/Documentation.md diff --git a/goals/EndpointsSpec.md b/docs/goals/EndpointsSpec.md similarity index 100% rename from goals/EndpointsSpec.md rename to docs/goals/EndpointsSpec.md diff --git a/goals/IncidentResponse.md b/docs/goals/IncidentResponse.md similarity index 100% rename from goals/IncidentResponse.md rename to docs/goals/IncidentResponse.md diff --git a/goals/ReliabilityEngineering.md b/docs/goals/ReliabilityEngineering.md similarity index 100% rename from goals/ReliabilityEngineering.md rename to docs/goals/ReliabilityEngineering.md diff --git a/goals/ScalabilityEngineering.md b/docs/goals/ScalabilityEngineering.md similarity index 100% rename from goals/ScalabilityEngineering.md rename to docs/goals/ScalabilityEngineering.md