What documentation resources are available?

[dcaribou]

Where do I start to know more about

• the project architecture
• common issues and a pitfalls
• available data / data dictionary
  ?

[dcaribou]

📐 Project architecture

The project architecture is described in the root README. Documentation in there is intentionally kept at a high level so that maintenance is a little easier, but it should give a general understanding of how things work.

Subfolders like data and dbt may also provide their own README with additional details.

🔫 Common issues

The Discussions and particularly the FAQs category (#175) is a good place to find about common issues and how to approach those. Also, the project READMEs include callouts (identified with a ⚠️) that are there to inform about common gotchas.

📖 Data dictionary

Although the README includes a high-level diagram of the available assets and their relationships, frontends are usually the best way to explore asset attributes. In particular, the "🔎 Explore" tab in the streamlit app should be helpful for this.