docs: improve README for ingestion pipeline clarity and presentation readiness#39
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This PR improves the project README to better reflect the current state of the ingestion pipeline after Dockerization and recent ETL enhancements.
The goal is to make the repository easier to understand, run, and present for both technical reviewers and the project demo.
Changes
stg_rejects)Motivation
The previous README was functionally correct but lacked clarity in:
This update improves readability and better communicates system design decisions.
Current System Context
The system now supports:
stg_*)stg_rejectswith reason and payloadFuture Alignment
This README prepares the project for future extensions including:
Verification
No functional code changes were introduced in this PR.
Validation performed:
Notes
This PR is documentation-focused and does not modify pipeline logic.