GITBOOK-384: Updated "welcome" copy, add "our app" section and markdown reference

2026-02-06 10:47:06 +00:00 · 2023-02-10 23:18:46 +00:00 · 2023-02-10 23:18:46 +00:00 · 7a27edd136
commit 7a27edd136
parent 00b2004068
45 changed files with 207 additions and 20 deletions
--- a/README.md
+++ b/README.md
@ -1,35 +1,39 @@
 ---
 description: >-
-  Flipside generates the world's most usable, comprehensive blockchain data, and
-  gives you the tools you need to access it for free.
+  Flipside generates the most reliable and comprehensive blockchain data. And we
+  have the tools that let you build more with it. All for free.
 ---

 # Welcome to Flipside!

 ### Getting Started

-With the app at [flipsidecrypto.xyz](https://flipsidecrypto.xyz), and a little SQL knowledge, you can analyze blockchain data, visualize it, and share your results instantly. **The app is the where most people get started,** and it's perfect for everything from casual data exploration to intricate storytelling with comprehensive visualization and dashboarding tools. If you're looking for inspiration, you can also explore the published work of the best analyst community in web3 — it's right there on the homepage!
-
-If you need **programmatic access** to blockchain data (say: you're building an app, or a trading model, or you prefer working locally in R or Python), you'll want to get set up with API access via [ShroomDK](broken-reference).
-
-**If you're part of a team** that's looking to work with our data in your own Snowflake environment, join our data with your internal data, or download large data sets from us, you'll want to request access to our [Snowflake Data Shares](data-shares/snowflake-data-shares.md).
+🌲 **The core Flipside App**: [www.flipsidecrypto.xyz](http://www.flipsidecrypto.xyz/)\
+Analyze blockchain data, visualize it, and share a dashboard instantly. \
+Ideal for: data exploration, analytical storytelling, comprehensive dashboard-building.\
+\
+🍄 **ShroomDK, the developer-friendly API**: [sdk.flipsidecrypto.xyz](https://sdk.flipsidecrypto.xyz/)\
+Skip the app, and submit queries directly from your dev or data science environment.\
+Ideal for: building a custom analytics app, constructing a trading model, or using Flipside data in R or Python for data science work.\
+\
+❄️ **Data Shares (via Snowflake)**: [data.flipsidecrypto.xyz/](https://data.flipsidecrypto.xyz/)\
+Want Flipside's entire database in your stack? We can do that. Just [reach out](https://data.flipsidecrypto.xyz/). \
+Ideal for: teams that rely on blockchain data to operate, understand their users, or make applications more web3-connected.

 ### Important Things to Know

 * All our data is accessible via SQL queries.
-* Snowflake is our data store, so you'll use [Snowflake SQL](our-data/using-snowflake-sql.md) to access it.
-* Our data structures are and designed for ease of use and efficient querying, and are  [extensively documented](our-data/data-table-documentation.md).&#x20;
+* You'll use the [Snowflake SQL](our-data/using-snowflake-sql.md) dialect to access it.
+* Our data structures are and designed for ease of use and efficient querying, and are  [extensively documented](our-data/data-table-documentation.md). We regularly update our data structures to optimize efficiency.
 * Latency varies from table to table, but typically lags either 1 hour or 1 day, at most.
-* If you run into difficulty getting your queries to run, we provide [guidance for efficient query writing](our-data/writing-efficient-queries.md) — and you can always get help in our [Discord](https://discord.gg/ZmU3jQuu6W).
+* If you run into difficulty getting your queries to run, we provide [a guide for efficient query writing](our-data/writing-efficient-queries.md). Need more assistance? Get help anytime in our [Discord](https://discord.gg/ZmU3jQuu6W).

 ### What blockchains and projects does Flipside have data on?

-If it happens on-chain, we've got it. Data include core tables (blocks, events, transactions) for every chain, with added 'easy' tables (swaps, prices, etc.) and project-specific tables modeled by the Flipside community.
+If it happens on-chain, we've got it.&#x20;
+
+Data include core tables (blocks, events, transactions) for every chain, with added 'easy' tables (swaps, prices, etc.) and project-specific tables modeled by the Flipside community.

 See our [Data Table Documentation](our-data/data-table-documentation.md) for a current list of supported chains.

-
-
-__\
-__
-
+Don’t see the chain you’re looking for? We add new chains regularly, but you can drop a request in our [Discord](https://discord.gg/ZmU3jQuu6W) anytime.
--- a/SUMMARY.md
+++ b/SUMMARY.md
@ -2,6 +2,10 @@

 * [Welcome to Flipside!](README.md)

+## Our App
+
+* [Markdown Reference](our-app/markdown-reference.md)
+
 ## Our Data

 * [Data Table Documentation](our-data/data-table-documentation.md)
--- a/our-app/markdown-reference.md
+++ b/our-app/markdown-reference.md
@ -0,0 +1,20 @@
+---
+description: For styling and organizing text blocks on your dashboards.
+---
+
+# Markdown Reference
+
+|                 |                                                               |
+| --------------- | ------------------------------------------------------------- |
+| Bold            | \*\*text\*\*                                                  |
+| Italic          | \_text\_                                                      |
+| Heading 1       | # Text                                                        |
+| Heading 2       | ## Text                                                       |
+| Heading 3       | ### Text                                                      |
+| Link            | \[Link text]\(https://flipsidecrypto.xyz)                     |
+| Image or Gif    | !\[alt text]\(http://url/to/img.png)                          |
+| Inline Code     | \`code\`                                                      |
+| Code Block      | \`\`\`code block\`\`\`                                        |
+| Horizontal Rule | ---                                                           |
+| Ordered List    | <p>1. First item</p><p>2. Second Item</p><p>3. Third Item</p> |
+| Unordered List  | <p>- First item</p><p>- Second Item</p><p>- Third Item</p>    |
--- a/our-data/archive/README.md
+++ b/our-data/archive/README.md
@ -4,3 +4,4 @@ description: Legacy documentation, for reference only.

 # Archive

+Please assume documents in this area are not up to date — they're available for reference only — and refer to [data-table-documentation.md](../data-table-documentation.md "mention") for the latest information. Thanks!
--- a/our-data/archive/algorand-tutorials.md
+++ b/our-data/archive/algorand-tutorials.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Algorand Tutorials

 {% embed url="https://www.youtube.com/watch?v=WOsrxrcdy88" %}
--- a/our-data/archive/data-updates.md
+++ b/our-data/archive/data-updates.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Data Updates

 **Join our** [**Discord**](https://discord.gg/ZmU3jQuu6W) **for recent data updates.**&#x20;
--- a/our-data/archive/tables/README.md
+++ b/our-data/archive/tables/README.md
@ -1,7 +1,8 @@
 ---
 description: >-
-  This section provides documentation on the schemas and design decisions behind
-  every queryable table.
+  [Legacy Documentation, Not Maintained, For Reference Only] This section
+  provides documentation on the schemas and design decisions behind every
+  queryable table.
 ---

 # Legacy Table Documentation
--- a/our-data/archive/tables/aave-tables/README.md
+++ b/our-data/archive/tables/aave-tables/README.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # AAVE Tables

 AAVE is a lending platform, somewhat similar in scope and design to Compound. As a result we have a similar design schema for this project. Feedback remains very welcome as much of this data remains very beta!
--- a/our-data/archive/tables/aave-tables/borrows.md
+++ b/our-data/archive/tables/aave-tables/borrows.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Borrows


--- a/our-data/archive/tables/aave-tables/deposits.md
+++ b/our-data/archive/tables/aave-tables/deposits.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Deposits


--- a/our-data/archive/tables/aave-tables/flashloans.md
+++ b/our-data/archive/tables/aave-tables/flashloans.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Flashloans


--- a/our-data/archive/tables/aave-tables/liquidations.md
+++ b/our-data/archive/tables/aave-tables/liquidations.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Liquidations


--- a/our-data/archive/tables/aave-tables/market-stats.md
+++ b/our-data/archive/tables/aave-tables/market-stats.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Market Stats


--- a/our-data/archive/tables/aave-tables/proposals.md
+++ b/our-data/archive/tables/aave-tables/proposals.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Proposals


--- a/our-data/archive/tables/aave-tables/repayments.md
+++ b/our-data/archive/tables/aave-tables/repayments.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Repayments


--- a/our-data/archive/tables/aave-tables/votes.md
+++ b/our-data/archive/tables/aave-tables/votes.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Votes


--- a/our-data/archive/tables/aave-tables/withdraws.md
+++ b/our-data/archive/tables/aave-tables/withdraws.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Withdraws


--- a/our-data/archive/tables/algorand-tables/README.md
+++ b/our-data/archive/tables/algorand-tables/README.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Algorand Tables

 The Algorand tables schema are based on the [Algorand indexer](https://github.com/algorand/indexer/releases/tag/2.8.0). Algorand tables are available in [the Flipside app](https://app.flipsidecrypto.com/velocity) as the `algorand` schema. The tables are built based on the algorand asset, app, account,  block, and transaction information.
--- a/our-data/archive/tables/algorand-tables/algorand-base-tables/README.md
+++ b/our-data/archive/tables/algorand-tables/algorand-base-tables/README.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Algorand Base Tables

 The Algorand base tables contains data directly from the Algorand indexer with the exception of the transaction tables which are broken out into the different types of transactions that can be performed on the Algorand blockchain.
--- a/our-data/archive/tables/arbitrum-tables.md
+++ b/our-data/archive/tables/arbitrum-tables.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Arbitrum Tables

 Documentation for \`arbitrum\` tables can be found [here](https://flipsidecrypto.github.io/arbitrum-models/#!/overview).
--- a/our-data/archive/tables/astroport-tables/README.md
+++ b/our-data/archive/tables/astroport-tables/README.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Astroport Tables

 Astroport is an automated market-maker (AMM) protocol on the Terra blockchain.&#x20;
--- a/our-data/archive/tables/avalanche-tables.md
+++ b/our-data/archive/tables/avalanche-tables.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Avalanche Tables

 Documentation for \`avalanche\` tables can be found [here](https://flipsidecrypto.github.io/avalanche-models/#!/overview).
--- a/our-data/archive/tables/axelar-tables.md
+++ b/our-data/archive/tables/axelar-tables.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Axelar Tables

 ## Current Axelar Tables
--- a/our-data/archive/tables/bsc-tables.md
+++ b/our-data/archive/tables/bsc-tables.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # BSC Tables

 Documentation for \`bsc\` tables can be found [`here`](https://flipsidecrypto.github.io/bsc-models/#!/overview).
--- a/our-data/archive/tables/compound-tables/README.md
+++ b/our-data/archive/tables/compound-tables/README.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Compound Tables

 **Blockchain:** [Ethereum](https://ethereum.org/en/)
--- a/our-data/archive/tables/cosmos-tables.md
+++ b/our-data/archive/tables/cosmos-tables.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Cosmos Tables

 ### **Current Cosmos Tables**
--- a/our-data/archive/tables/crosschain-tables/README.md
+++ b/our-data/archive/tables/crosschain-tables/README.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Crosschain Tables

 These tables contain data from multiple blockchains. The following tables are available in the Crosschain schema:\
--- a/our-data/archive/tables/ethereum-beacon-chain-tables.md
+++ b/our-data/archive/tables/ethereum-beacon-chain-tables.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Ethereum Beacon Chain Tables

 Documentation for Ethereum.Beacon\_chain tables can be found [here](https://flipsidecrypto.github.io/ethereum-models/#!/model/model.ethereum\_models.beacon\_chain\_\_fact\_attestations).
--- a/our-data/archive/tables/ethereum-beta-tables.md
+++ b/our-data/archive/tables/ethereum-beta-tables.md
@ -1,7 +1,8 @@
 ---
 description: >-
-  These tables are subject to change without notice! Do not use these for
-  dashboards or important analysis.
+  [Legacy Documentation, Not Maintained, For Reference Only] These tables are
+  subject to change without notice! Do not use these for dashboards or important
+  analysis.
 ---

 # Ethereum Beta Tables
--- a/our-data/archive/tables/ethereum-chainlink-tables.md
+++ b/our-data/archive/tables/ethereum-chainlink-tables.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Ethereum Chainlink Tables

 Documentation for `ethereum.chainlink` tables can be found here:
--- a/our-data/archive/tables/ethereum-maker-dao-tables.md
+++ b/our-data/archive/tables/ethereum-maker-dao-tables.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Ethereum Maker DAO Tables

 Documentation for the curated Ethereum Maker DAO Tables are included in [the Ethereum Core DBT documentation](https://flipsidecrypto.github.io/ethereum-models/#!/overview/ethereum\_models) under the following path in the sidebar: Projects/Ethereum\_models/models/gold/maker
--- a/our-data/archive/tables/ethereum-sushi-tables.md
+++ b/our-data/archive/tables/ethereum-sushi-tables.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Ethereum Sushi Tables

 Documentation for the curated Ethereum Sushi Tables are included in [the Ethereum Core DBT documentation](https://flipsidecrypto.github.io/ethereum-models/#!/overview/ethereum\_models) under the following path in the sidebar: Projects/Ethereum\_models/models/sushi
--- a/our-data/archive/tables/ethereum-tables.md
+++ b/our-data/archive/tables/ethereum-tables.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Ethereum Tables

 Documentation for `Ethereum_core` tables can be found [here](https://flipsidecrypto.github.io/ethereum-models/#!/overview).&#x20;
--- a/our-data/archive/tables/flow-tables/README.md
+++ b/our-data/archive/tables/flow-tables/README.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # FLOW Tables

 The [Flow blockchain](https://www.onflow.org/primer) is a fast, decentralized blockchain that enhances the development of decentralized applications and NFTs. Like other blockchains, Flow has its own native currency, known as FLOW. FLOW is the reserve asset used to pay transaction costs and staking on the network.
--- a/our-data/archive/tables/gnosis-tables.md
+++ b/our-data/archive/tables/gnosis-tables.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Gnosis Tables

 Documentation for \`gnosis\` tables can be found [here](https://flipsidecrypto.github.io/gnosis-models/#!/overview).
--- a/our-data/archive/tables/near-tables.md
+++ b/our-data/archive/tables/near-tables.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # NEAR Tables

 The data models for NEAR have been updated to use the [Near Lake S3 Bucket](https://docs.near.org/tools/realtime#near-lake-indexer), which is the same data source that feeds NEAR's explorer, as of January 23rd, 2023. The core views available to Flipside data users remain the exact same, but the below linked documentation may be a bit cumbersome until the legacy models are fully deleted. If using the lineage graph, [apply a filter on the tag `s3_load`](https://flipsidecrypto.github.io/near-models/#!/overview?g\_v=1\&g\_i=%2Btag:s3\_load%2B%20%2Btag:api%2B) to exclude legacy models. Further, deprecated models have been moved to `models/silver/legacy/` to keep them out of sight.
--- a/our-data/archive/tables/optimism-tables.md
+++ b/our-data/archive/tables/optimism-tables.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Optimism Tables

 Documentation for `optimism` tables can be found [here](https://flipsidecrypto.github.io/optimism-models/#!/overview).
--- a/our-data/archive/tables/osmosis-tables/README.md
+++ b/our-data/archive/tables/osmosis-tables/README.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Osmosis Tables

 ### Background of Osmosis
--- a/our-data/archive/tables/polygon-2.0-tables.md
+++ b/our-data/archive/tables/polygon-2.0-tables.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Polygon 2.0 Tables

 Documentation for \`polygon\` tables can be found [here](https://flipsidecrypto.github.io/polygon-models/#!/overview).
--- a/our-data/archive/tables/polygon-tables/README.md
+++ b/our-data/archive/tables/polygon-tables/README.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Polygon Tables

 **Blockchain:** [Polygon](https://polygon.technology/)
--- a/our-data/archive/tables/solana-tables.md
+++ b/our-data/archive/tables/solana-tables.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Solana Tables

 ### Background of Solana
--- a/our-data/archive/tables/terra-tables/README.md
+++ b/our-data/archive/tables/terra-tables/README.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Terra Tables

 ## Background of Terra
--- a/our-data/archive/tables/terraswap-tables/README.md
+++ b/our-data/archive/tables/terraswap-tables/README.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Terraswap Tables

 From the [Terraswap docs](https://docs.terraswap.io/) : "Terraswap is a Uniswap-inspired automated market-maker (AMM) protocol implemented with smart contracts on the Terra blockchain."
--- a/our-data/archive/tables/thorchain-tables/README.md
+++ b/our-data/archive/tables/thorchain-tables/README.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # THORChain Tables

 **Blockchain:** [THORChain](https://thorchain.org/)
--- a/our-data/archive/tables/uniswap-v3-tables/README.md
+++ b/our-data/archive/tables/uniswap-v3-tables/README.md
@ -1,3 +1,7 @@
+---
+description: '[Legacy Documentation, Not Maintained, For Reference Only]'
+---
+
 # Uniswap V3 Tables

 **Blockchain:** [Ethereum](https://ethereum.org/en/)