Problem
ARCHITECTURE.md (added in #158) maps the src/freshdata codebase, but nothing inside the source points readers to it. Someone browsing a subpackage's __init__.py has no breadcrumb back to the map.
Note: depends on #158 merging first (that PR adds ARCHITECTURE.md).
Expected outcome
Each subpackage __init__.py docstring ends with a one-line pointer, e.g.:
See ARCHITECTURE.md for how this package fits into the overall cleaning flow.
Relevant files
The __init__.py of each subpackage listed in ARCHITECTURE.md: engine/, steps/, imputation/, domains/, semantic/, context/, enterprise/, compliance/, execution/, streaming/, parsers/, render/, models/, learning/, integrations/, adapters/, experimental/.
Acceptance criteria
Difficulty / skills
good first issue — Python, orientation reading. A safe, mechanical first PR.
Problem
ARCHITECTURE.md(added in #158) maps thesrc/freshdatacodebase, but nothing inside the source points readers to it. Someone browsing a subpackage's__init__.pyhas no breadcrumb back to the map.Expected outcome
Each subpackage
__init__.pydocstring ends with a one-line pointer, e.g.:Relevant files
The
__init__.pyof each subpackage listed inARCHITECTURE.md:engine/,steps/,imputation/,domains/,semantic/,context/,enterprise/,compliance/,execution/,streaming/,parsers/,render/,models/,learning/,integrations/,adapters/,experimental/.Acceptance criteria
ruff check .andmypy src/freshdatapass.pytest -m "not online and not large") stays green.Difficulty / skills
good first issue— Python, orientation reading. A safe, mechanical first PR.