From edde2c499d8646ec445467c6549465b7d25afa56 Mon Sep 17 00:00:00 2001
From: noruzzamans <noruzzamanrubel@gmail.com>
Date: Thu, 25 Dec 2025 19:48:01 +0600
Subject: [PATCH] docs: Add quick-start sections to component README files

- Add quick-start commands to api/README.md
- Add quick-start commands to catalog/README.md
- Add quick-start commands to frontend/README.md
- Add quick-start commands to ingestion_server/README.md
- Add package overview to packages/README.md

These additions help developers quickly understand how to work with
each component without needing to navigate to full documentation first.
---
 api/README.md              | 15 +++++++++++++++
 catalog/README.md          | 15 +++++++++++++++
 frontend/README.md         | 15 +++++++++++++++
 ingestion_server/README.md | 15 +++++++++++++++
 packages/README.md         | 14 ++++++++++++++
 5 files changed, 74 insertions(+)

diff --git a/api/README.md b/api/README.md
index bd2e0272ff1..f173ee32760 100644
--- a/api/README.md
+++ b/api/README.md
@@ -2,3 +2,18 @@
 
 This service is documented at
 [docs.openverse.org/api](https://docs.openverse.org/api/index.html).
+
+## Quick Start
+
+```bash
+# Start the API server
+just api/up
+
+# Run tests
+just api/test
+
+# Run linting
+just lint
+```
+
+See the [justfile](justfile) for more available commands.
diff --git a/catalog/README.md b/catalog/README.md
index 813b4262d37..5396c91dfdc 100644
--- a/catalog/README.md
+++ b/catalog/README.md
@@ -2,3 +2,18 @@
 
 This service is documented at
 [docs.openverse.org/catalog](https://docs.openverse.org/catalog/index.html).
+
+## Quick Start
+
+```bash
+# Start the catalog (Airflow)
+just catalog/up
+
+# Run tests
+just catalog/test
+
+# Run linting
+just lint
+```
+
+See the [justfile](justfile) for more available commands.
diff --git a/frontend/README.md b/frontend/README.md
index d5b9ba46a3e..99ce1b7323b 100644
--- a/frontend/README.md
+++ b/frontend/README.md
@@ -2,3 +2,18 @@
 
 This service is documented at
 [docs.openverse.org/frontend](https://docs.openverse.org/frontend/index.html).
+
+## Quick Start
+
+```bash
+# Start the development server
+pnpm run dev
+
+# Run unit tests
+pnpm run test:unit
+
+# Run E2E tests
+pnpm run test:playwright
+```
+
+See [package.json](package.json) for all available scripts.
diff --git a/ingestion_server/README.md b/ingestion_server/README.md
index 06ffcd8dd34..9bb0f52da75 100644
--- a/ingestion_server/README.md
+++ b/ingestion_server/README.md
@@ -2,3 +2,18 @@
 
 This service is documented at
 [docs.openverse.org/ingestion_server](https://docs.openverse.org/ingestion_server/index.html).
+
+## Quick Start
+
+```bash
+# Start the ingestion server
+just ingestion_server/up
+
+# Run tests
+just ingestion_server/test
+
+# Run linting
+just lint
+```
+
+See the [justfile](justfile) for more available commands.
diff --git a/packages/README.md b/packages/README.md
index 13b0e4aedb3..2d79c0cd5d3 100644
--- a/packages/README.md
+++ b/packages/README.md
@@ -2,3 +2,17 @@
 
 Learn more about these packages in the
 [documentation](https://docs.openverse.org/packages/index.html).
+
+## Available Packages
+
+### JavaScript Packages
+
+- `@openverse/api-client` - API client library
+- `@openverse/eslint-plugin` - ESLint configuration
+- `k6` - Performance testing scripts
+
+### Python Packages
+
+- `openverse-attribution` - Attribution utilities
+
+See individual package directories for more details.