added __overview__.md

models/descriptions/__overview__.md

@@ -0,0 +1,135 @@
+{% docs __overview__ %}
+
+# Welcome to the Flipside Crypto THORchain Models Documentation
+
+## **What does this documentation cover?**
+
+The documentation included here details the design of the THORchain
+tables and views available via [Flipside Crypto.](https://flipsidecrypto.xyz/insights/dashboards/thorchain) For more information on how these models are built, please see [the github repository.](https://github.com/FlipsideCrypto/thorchain-models)
+
+## **How do I use these docs?**
+
+The easiest way to navigate this documentation is to use the Quick Links below. These links will take you to the documentation for each table, which contains a description, a list of the columns, and other helpful information.
+
+If you are experienced with dbt docs, feel free to use the sidebar to navigate the documentation, as well as explore the relationships between tables and the logic building them.
+
+There is more information on how to use dbt docs in the last section of this document.
+
+## **Quick Links to Table Documentation**
+
+**Click on the links below to jump to the documentation for each schema.**
+
+### Core Schema (`thorchain`.`CORE`.`<table_name>`)
+
+- [core__dim_block](#!/model/model.thorchain_models.core__dim_block)
+- [core__dim_labels](#!/model/model.thorchain_models.core__dim_labels)
+- [core__dim_midgard](#!/model/model.thorchain_models.core__dim_midgard)
+- [core__fact_network_version_events](#!/model/model.thorchain_models.core__fact_network_version_events)
+- [core__fact_set_mimir_events](#!/model/model.thorchain_models.core__fact_set_mimir_events)
+- [core__fact_thorname_change_events](#!/model/model.thorchain_models.core__fact_thorname_change_events)
+- [core__fact_transfer_events](#!/model/model.thorchain_models.core__fact_transfer_events)
+- [core__fact_transfers](#!/model/model.thorchain_models.core__fact_transfers)
+- [core__fact_tss_keygen_failure_events](#!/model/model.thorchain_models.core__fact_tss_keygen_failure_events)
+- [core__fact_tss_keygen_success_events](#!/model/model.thorchain_models.core__fact_tss_keygen_success_events)
+
+### Defi Schema
+
+- [defi__fact_active_vault_events](#!/model/model.thorchain_models.defi__fact_active_vault_events)
+- [defi__fact_add_events](#!/model/model.thorchain_models.defi__fact_add_events)
+- [defi__fact_asgard_fund_yggdrasil_events](#!/model/model.thorchain_models.defi__fact_asgard_fund_yggdrasil_events)
+- [defi__fact_block_pool_depths](#!/model/model.thorchain_models.defi__fact_block_pool_depths)
+- [defi__fact_block_rewards](#!/model/model.thorchain_models.defi__fact_block_rewards)
+- [defi__fact_bond_actions](#!/model/model.thorchain_models.defi__fact_bond_actions)
+- [defi__fact_bond_events](#!/model/model.thorchain_models.defi__fact_bond_events)
+- [defi__fact_daily_earnings](#!/model/model.thorchain_models.defi__fact_daily_earnings)
+- [defi__fact_daily_pool_stats](#!/model/model.thorchain_models.defi__fact_daily_pool_stats)
+- [defi__fact_daily_tvl](#!/model/model.thorchain_models.defi__fact_daily_tvl)
+- [defi__fact_errata_events](#!/model/model.thorchain_models.defi__fact_errata_events)
+- [defi__fact_fee_events](#!/model/model.thorchain_models.defi__fact_fee_events)
+- [defi__fact_gas_events](#!/model/model.thorchain_models.defi__fact_gas_events)
+- [defi__fact_inactive_vault_events](#!/model/model.thorchain_models.defi__fact_inactive_vault_events)
+- [defi__fact_liquidity_actions](#!/model/model.thorchain_models.defi__fact_liquidity_actions)
+- [defi__fact_loan_open_events](#!/model/model.thorchain_models.defi__fact_loan_open_events)
+- [defi__fact_loan_repayment_events](#!/model/model.thorchain_models.defi__fact_loan_repayment_events)
+- [defi__fact_mint_burn_events](#!/model/model.thorchain_models.defi__fact_mint_burn_events)
+- [defi__fact_outbound_events](#!/model/model.thorchain_models.defi__fact_outbound_events)
+- [defi__fact_pending_liquidity_events](#!/model/model.thorchain_models.defi__fact_pending_liquidity_events)
+- [defi__fact_pool_balance_change_events](#!/model/model.thorchain_models.defi__fact_pool_balance_change_events)
+- [defi__fact_pool_block_balances](#!/model/model.thorchain_models.defi__fact_pool_block_balances)
+- [defi__fact_pool_block_fees](#!/model/model.thorchain_models.defi__fact_pool_block_fees)
+- [defi__fact_pool_block_statistics](#!/model/model.thorchain_models.defi__fact_pool_block_statistics)
+- [defi__fact_pool_events](#!/model/model.thorchain_models.defi__fact_pool_events)
+- [defi__fact_refund_events](#!/model/model.thorchain_models.defi__fact_refund_events)
+- [defi__fact_reserve_events](#!/model/model.thorchain_models.defi__fact_reserve_events)
+- [defi__fact_rewards_event_entries](#!/model/model.thorchain_models.defi__fact_rewards_event_entries)
+- [defi__fact_rewards_events](#!/model/model.thorchain_models.defi__fact_rewards_events)
+- [defi__fact_stake_events](#!/model/model.thorchain_models.defi__fact_stake_events)
+- [defi__fact_streamling_swap_details_events](#!/model/model.thorchain_models.defi__fact_streamling_swap_details_events)
+- [defi__fact_swaps](#!/model/model.thorchain_models.defi__fact_swaps)
+- [defi__fact_swaps_events](#!/model/model.thorchain_models.defi__fact_swaps_events)
+- [defi__fact_switch_events](#!/model/model.thorchain_models.defi__fact_switch_events)
+- [defi__fact_total_block_rewards](#!/model/model.thorchain_models.defi__fact_total_block_rewards)
+- [defi__fact_total_value_locked](#!/model/model.thorchain_models.defi__fact_total_value_locked)
+- [defi__fact_unstake_events](#!/model/model.thorchain_models.defi__fact_unstake_events)
+- [defi__fact_update_node_account_status_events](#!/model/model.thorchain_models.defi__fact_update_node_account_status_events)
+- [defi__fact_upgrades](#!/model/model.thorchain_models.defi__fact_upgrades)
+- [defi__fact_withdraw_events](#!/model/model.thorchain_models.defi__fact_withdraw_events)
+
+### Governance Schema
+
+- [gov__fact_new_node_events](#!/model/model.thorchain_models.gov__fact_new_node_events)
+- [gov__fact_set_ip_address_events](#!/model/model.thorchain_models.gov__fact_set_ip_address_events)
+- [gov__fact_set_node_keys_events](#!/model/model.thorchain_models.gov__fact_set_node_keys_events)
+- [gov__fact_set_version_events](#!/model/model.thorchain_models.gov__fact_set_version_events)
+- [gov__fact_slash_amounts](#!/model/model.thorchain_models.gov__fact_slash_amounts)
+- [gov__fact_slash_points](#!/model/model.thorchain_models.gov__fact_slash_points)
+- [gov__fact_validator_request_leave_events](#!/model/model.thorchain_models.gov__fact_validator_request_leave_events)
+
+### Price Schema
+
+- [price__dim_asset_metadata](#!/model/model.thorchain_models.price__dim_asset_metadata)
+- [price__ez_asset_metadata](#!/model/model.thorchain_models.price__ez_asset_metadata)
+- [price__ez_prices_hourly](#!/model/model.thorchain_models.price__ez_prices_hourly)
+- [price__fact_prices](#!/model/model.thorchain_models.price__fact_prices)
+- [price__fact_prices_ohlc_hourly](#!/model/model.thorchain_models.price__fact_prices_ohlc_hourly)
+
+## **Data Model Overview**
+
+While THORchain models are built a few different ways, they are organized into three layers of sql models: **bronze, silver, and gold (or core).**
+
+- Bronze: Data is loaded in from the source as a view
+- Silver: All necessary parsing, filtering, de-duping, and other transformations are done here
+- Gold (or core): Final views and tables that are available publicly
+
+The dimension tables are sourced from a variety of on-chain and off-chain sources.
+
+Convenience views (denoted ez\_) are a combination of different fact and dimension tables. These views are built to make it easier to query the data.
+
+## **Using dbt docs**
+
+### Navigation
+
+You can use the `Project` and `Database` navigation tabs on the left side of the window to explore the models in the project.
+
+### Database Tab
+
+This view shows relations (tables and views) grouped into database schemas. Note that ephemeral models are _not_ shown in this interface, as they do not exist in the database.
+
+### Graph Exploration
+
+You can click the blue icon on the bottom-right corner of the page to view the lineage graph of your models.
+
+On model pages, you'll see the immediate parents and children of the model you're exploring. By clicking the Expand button at the top-right of this lineage pane, you'll be able to see all of the models that are used to build, or are built from, the model you're exploring.
+
+Once expanded, you'll be able to use the `--models` and `--exclude` model selection syntax to filter the models in the graph. For more information on model selection, check out the [dbt docs](https://docs.getdbt.com/docs/model-selection-syntax).
+
+Note that you can also right-click on models to interactively filter and explore the graph.
+
+### **More information**
+
+- [THORchain on Flipside Crypto](https://flipsidecrypto.xyz/insights/dashboards/thorchain)
+- [Tutorials](https://docs.flipsidecrypto.com/our-data/tutorials)
+- [Github](https://github.com/FlipsideCrypto/thorchain-models)
+- [What is dbt?](https://docs.getdbt.com/docs/introduction)
+
+{% enddocs %}