Initial file creation of code documentation READMEs

ARCHITECTURE.md

@@ -4,16 +4,17 @@ The core function of dbt is SQL compilation and execution. Users create projects
 
 Most of the python code in the repository is within the `core/dbt` directory. Currently the main subdirectories are:
 
-- [`adapters`](core/dbt/adapters): Define base classes for behavior that is likely to differ across databases
+- [`adapters`](core/dbt/adapters/README.md): Define base classes for behavior that is likely to differ across databases
-- [`clients`](core/dbt/clients): Interface with dependencies (agate, jinja) or across operating systems
+- [`clients`](core/dbt/clients/README.md): Interface with dependencies (agate, jinja) or across operating systems
-- [`config`](core/dbt/config): Reconcile user-supplied configuration from connection profiles, project files, and Jinja macros
+- [`config`](core/dbt/config/README.md): Reconcile user-supplied configuration from connection profiles, project files, and Jinja macros
-- [`context`](core/dbt/context): Build and expose dbt-specific Jinja functionality
+- [`context`](core/dbt/context/README.md): Build and expose dbt-specific Jinja functionality
-- [`contracts`](core/dbt/contracts): Define Python objects (dataclasses) that dbt expects to create and validate
+- [`contracts`](core/dbt/contracts/README.md): Define Python objects (dataclasses) that dbt expects to create and validate
-- [`deps`](core/dbt/deps): Package installation and dependency resolution
+- [`deps`](core/dbt/deps/README.md): Package installation and dependency resolution
-- [`graph`](core/dbt/graph): Produce a `networkx` DAG of project resources, and selecting those resources given user-supplied criteria
+- [`events`](core/dbt/events/README.md): Logging events
-- [`include`](core/dbt/include): The dbt "global project," which defines default implementations of Jinja2 macros
+- [`graph`](core/dbt/graph/README.md): Produce a `networkx` DAG of project resources, and selecting those resources given user-supplied criteria
-- [`parser`](core/dbt/parser): Read project files, validate, construct python objects
+- [`include`](core/dbt/include/README.md): The dbt "global project," which defines default implementations of Jinja2 macros
-- [`task`](core/dbt/task): Set forth the actions that dbt can perform when invoked
+- [`parser`](core/dbt/parser/README.md): Read project files, validate, construct python objects
+- [`task`](core/dbt/task/README.md): Set forth the actions that dbt can perform when invoked
 
 ### Invoking dbt
 

core/dbt/README.md

@@ -0,0 +1,52 @@
+# core/dbt directory README
+
+## The following are individual files in this directory.
+
+### deprecations.py
+
+### flags.py		
+
+### main.py			
+
+### tracking.py		
+
+### version.py
+
+### lib.py
+
+### node_types.py
+
+### helper_types.py		
+
+### links.py		
+
+### semver.py		
+
+### ui.py
+
+### compilation.py		
+
+### dataclass_schema.py	
+
+### exceptions.py		
+
+### hooks.py		
+
+### logger.py		
+
+### profiler.py		
+
+### utils.py
+
+
+## The subdirectories will be documented in a README in the subdirectory
+* config
+* include
+* adapters
+* context
+* deps
+* graph
+* task
+* clients
+* events
+

core/dbt/adapters/README.md

@@ -0,0 +1 @@
+# Adapters README

core/dbt/clients/README.md

@@ -0,0 +1 @@
+# Clients README

core/dbt/config/README.md

@@ -0,0 +1 @@
+# Config README

core/dbt/context/README.md

@@ -0,0 +1 @@
+# Contexts and Jinja rendering

core/dbt/contracts/README.md

@@ -0,0 +1 @@
+# Contracts README

core/dbt/deps/README.md

@@ -0,0 +1 @@
+# Deps README

core/dbt/graph/README.md

@@ -0,0 +1 @@
+# Graph README

core/dbt/include/README.md

@@ -0,0 +1 @@
+# Include README

core/dbt/parser/README.md

@@ -0,0 +1 @@
+# Parser README

core/dbt/task/README.md

@@ -0,0 +1 @@
+# Task README

test/integration/README.md

@@ -0,0 +1 @@
+# Integration test README

test/unit/README.md

@@ -0,0 +1 @@
+# Unit test README