GITBOOK-387: Initial "Our App" section, small change to Labels

README.md

@@ -8,7 +8,7 @@ description: >-
 
 ### Getting Started
 
-🌲 **The core Flipside App**: [www.flipsidecrypto.xyz](http://www.flipsidecrypto.xyz/)\
+🌲 **The core Flipside App**: [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.\
 \
@@ -16,14 +16,14 @@ Ideal for: data exploration, analytical storytelling, comprehensive dashboard-bu
 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/)\
+❄️ **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.
-* You'll use the [Snowflake SQL](our-data/using-snowflake-sql.md) dialect to access it.
+* All our data is accessible via SQL queries, and you'll use the [Snowflake SQL](our-data/using-snowflake-sql.md) dialect to access it.
+* Our core app is brand new (launched Feb 2023) and some [documentation](our-app/app-overview.md) is available — we're actively building this out, including both text and video content — if you have questions that aren't answered here, please reach out in [Discord](https://discord.gg/ZmU3jQuu6W).
 * 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 [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).
@@ -34,6 +34,4 @@ 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.
 
-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.
+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.

SUMMARY.md

@@ -4,6 +4,9 @@
 
 ## Our App
 
+* [App Overview](our-app/app-overview.md)
+* [App Walkthrough](our-app/app-walkthrough.md)
+* [Keyboard Shortcuts](our-app/keyboard-shortcuts.md)
 * [Markdown Reference](our-app/markdown-reference.md)
 
 ## Our Data

our-app/app-overview.md

@@ -0,0 +1,22 @@
+---
+description: Our data app is the easiest place to get started working with blockchain data.
+---
+
+# App Overview
+
+With a little bit of SQL knowledge, the Flipside data app makes it incredibly easy to access the best blockchain data in the world. To get started, we recommend stepping through our [walkthrough](app-walkthrough.md) — it's designed to get you up to speed on the basics of the app as quickly as possible.
+
+The app has a few basic components, here's how they fit together:
+
+* **Discover** — the homepage of the app, and the best way to keep your finger on the pulse of what's happening in crypto data. Here you can see what dashboards are trending for different chains and projects, fav ones you like, keyword search for specific topics, and see which analysts are consistently topping the charts.
+* **Editor** — where the work happens: get here by creating a query, or opening one you've started before. Run SQL queries, get results, visualize them, and publish them on a dashboard, all from one place in the app. Seamlessly switch between any of your queries and dashboards with our tabs system, and use the Data Explorer to preview data tables, and add table names directly to your queries. 
+* **Dashboards** — where you share your findings with the world: add charts, results tables, text and images to your dashboards, send them to your friends with our copy link feature, or tweet the link directly from the dashboard. Organize your findings with dashboard tabs, and let people customize or update your dashboard with parameters.
+* **Profiles** — your profile is the place where people can find all your best work, search and filter it, and see how to get get in touch with you if that's something you want! Update your avatar and background image, and add social contact details for Twitter, Telegram and Discord.
+
+We're adding more documentation for the app over time — if you have questions or suggestions for things to add, please let us know in [Discord](https://discord.gg/ZmU3jQuu6W).
+
+#### References
+
+* [Query Editor Keyboard Shortcuts](keyboard-shortcuts.md)
+* [Dashboard Markdown Reference](markdown-reference.md)
+

our-app/app-walkthrough.md

@@ -0,0 +1,154 @@
+---
+description: How to get started with the Flipside data app.
+---
+
+# App Walkthrough
+
+### Step 1: Create an account.
+
+To get started, create an account on our app — you can sign up using an email address, ETH address, or your discord account. 
+
+<figure><img src="../.gitbook/assets/Screenshot 2023-02-15 at 8.12.06 PM.png" alt=""><figcaption><p>The account sign-up link is in the bottom left-hand corner of the page.</p></figcaption></figure>
+
+###
+
+### Step 2: **Create a new query.**
+
+You can create a new query by clicking the big blue "+ Create New" button in the main navigation panel, then selecting "Query."
+
+<figure><img src="../.gitbook/assets/Screenshot 2023-02-15 at 8.09.14 PM.png" alt=""><figcaption><p>Easiest way to create a new query is to click the big blue button.</p></figcaption></figure>
+
+You can also create new queries in a few other ways:
+
+* from My Work, with the + button.
+* if you have the Editor open, from the query tab bar with the + button there.
+* by entering [flipside.new](https://flipside.new) into your browser's URL bar.
+
+Doing this will drop you into the Editor part of the app, with your new query open:
+
+<figure><img src="../.gitbook/assets/Screenshot 2023-02-15 at 3.50.59 PM.png" alt=""><figcaption><p>Brand new query, ready for SQL.</p></figcaption></figure>
+
+A few things to note here:
+
+* By default, your query is named the date and time it was created. You can rename it by clicking on its name in the query task bar (above the code editor and below the tabs).
+* The "My Work" menu will be expanded in the left sidebar, and a new line representing your query will be added to it. Here you can organize your queries, search them by title, and navigate between them. More on that later.
+* When you create a fresh query, your cursor will be focused in the code editor. Here you can enter SQL to query the various blockchain databases on offer. How do you know which databases to query, though? Well...
+
+
+
+### Step 3: **Explore Flipside's data.**&#x20;
+
+From the side menu, navigate to the Data Explorer to see all the databases, schemas and tables available to you — there is typically one database dedicated to each blockchain we cover. For now, let's take a look at one of our Ethereum core tables: so click Ethereum, then Core, then "ez\_token\_transfers" to expand that table's details.
+
+Pro tips for data exploration:
+
+* **Column details:** click on the table name to see a list of it's columns, and a data type for each.
+* **Table preview**: see sample data without writing any SQL by clicking the Preview icon.
+* **Add to query**: enter any table name into your SQL with a single mouse click.&#x20;
+* **View docs:** hover over a database name and click the "book" icon to go direct to docs.
+
+<figure><img src="../.gitbook/assets/Explore data.png" alt=""><figcaption><p>The data explorer is the easiest way to find tables, check out their contents, and add them to your query.</p></figcaption></figure>
+
+
+
+### Step 4: **Write your query → run it → see results**  &#x20;
+
+Now let's run a query from that table. Here's one you can use, that gets the top 8 NFT projects on Ethereum by total ETH spent on mints in the past week:
+
+```sql
+select 
+  project_name,
+  round(sum(mint_price_eth * nft_count),0) as eth_spent
+from ethereum.core.ez_nft_mints
+where project_name is not null 
+  and nft_count > 0
+  and nft_count is not null
+  and project_name not in ('uniswap')
+  and block_timestamp > current_date - interval '7 days'
+group by 1
+order by eth_spent desc
+limit 8
+```
+
+Paste that into the code editor (and modify it if you like: maybe change the "limit" and get top 10 instead of 8, or change the "interval" get total mints from past month instead of week?) and you're ready to go.
+
+To run your query, you can hit the big blue "play" button in the top right-hand corner, or use a keyboard shortcut:
+
+* Mac: CMD + ENTER
+* PC or Linux: CTRL + ENTER
+
+After a few moments, you should see your results appear in the Results Panel — you've got data!
+
+<figure><img src="../.gitbook/assets/Screenshot 2023-02-15 at 4.37.13 PM.png" alt=""><figcaption><p>Your screen should look something like this at this point.</p></figcaption></figure>
+
+###
+
+### Step 5: **Visualize the data!**
+
+Let's take a look at what the table above is telling us! Click **"New Chart"** on the bottom of the screen to fire up the chart builder. For this example, we'll choose **Bar** chart from the chart type menu, then set a few options to get started:
+
+* for X Axis, select "PROJECT\_NAME"
+* for Y Axis (Bar) select "ETH\_SPENT"
+* for Group By Value select "PROJECT\_NAME
+
+Your screen should look something like this:
+
+<figure><img src="../.gitbook/assets/Screenshot 2023-02-15 at 4.49.04 PM.png" alt=""><figcaption><p>You've got a chart!</p></figcaption></figure>
+
+###
+
+### Step 6: **Create a dashboard and publish.**
+
+Now that you have your results and a basic chart, you can tie everything together by creating a dashboard. Click the "add to dashboard" icon in the chart panel, then click "+ New Dashboard" to get started:
+
+<figure><img src="../.gitbook/assets/Screenshot 2023-02-15 at 8.15.17 PM.png" alt=""><figcaption><p>"Add to dashboard" is the quickest way to get a new chart into a dashboard.</p></figcaption></figure>
+
+<figure><img src="../.gitbook/assets/Screenshot 2023-02-15 at 8.16.45 PM.png" alt=""><figcaption><p>This interface lets you find an existing dashboard to add your chart to, or instantly create at new one.</p></figcaption></figure>
+
+<figure><img src="../.gitbook/assets/Screenshot 2023-02-15 at 8.29.30 PM.png" alt=""><figcaption><p>Your new dashboard is ready to edit! It should look something like this.</p></figcaption></figure>
+
+###
+
+### Step 7: **Publish and Share!**
+
+There are many ways to customize a dashboard — you can add text boxes, charts, tables, and images to your dashboard to showcase what you've discovered, resize and arrange them as you see fit, and even organize them in tabs.&#x20;
+
+For now, we'll stick to the basics — let's give this dashboard a name! Click the default assigned name (the date and time the dashboard was created) and name it something appropriate like "NFT Mint Volume Walkthrough".
+
+<figure><img src="../.gitbook/assets/Screenshot 2023-02-15 at 8.20.15 PM.png" alt=""><figcaption><p>Click the big timestamp and name it something appropriate.</p></figcaption></figure>
+
+Make any other changes you see fit:
+
+* **Action Bar**: you can add text, images, or charts from the action bar at the bottom of the page.
+* **My Work**: you can also drag charts and results tables onto the dashboard from My Work.
+* **Tabs**: finally you can create additional pages or "tabs" in your dashboard to help organize your work by clicking the "Activate Tab Mode" box, and then adding tabs with the + button, and editing or removing them with the gear icon.
+
+Once you're happy with your dashboard, hit the publish button on the top right corner — after a short delay, you should see a confirmation like this:
+
+<figure><img src="../.gitbook/assets/Screenshot 2023-02-15 at 8.35.24 PM.png" alt=""><figcaption><p>Your dashboard publish confirmation shows you a preview of how your dashboard will appear when shared on the web.</p></figcaption></figure>
+
+###
+
+### Step 8: **Find it in Discover.**&#x20;
+
+Now that your dashboard is published, you can find it in Discover:
+
+<figure><img src="../.gitbook/assets/Screenshot 2023-02-15 at 8.38.16 PM.png" alt=""><figcaption><p>Click that Discover link!</p></figcaption></figure>
+
+There are a few ways to find your dashboard in discover, here's the easiest one:
+
+1. Click "Analysts" to find your account in the Analyst Leaderboard.
+2. Click "Search" and enter your username to find your profile.
+3. Click your profile card to go to your profile page.
+4. Your dashboard should show up near the top!
+
+<figure><img src="../.gitbook/assets/Screenshot 2023-02-15 at 8.43.16 PM.png" alt=""><figcaption><p>Get to the analysts section and search for your profile to find your dashboard.</p></figcaption></figure>
+
+Congrats — you've published!
+
+### Next Steps:
+
+* **Edit your profile** — add contact information, customize your avatar and background image.
+* **Get inspired** — go back to Discover and scope out the trending work: filter by a project you're interested in, and see what the best analysts in crypto are making on Flipside. Oh, and if you see something you like, be sure to hit that ❤️ button — "likes" impact the rankings and you'll help more people see good work by voting for things you enjoy.
+* **Check out bounties** — there are a few [Flipside bounties](https://app.gitbook.com/s/q3ZsciVeKRUUcuezp6ax/rpc/data-types/sqlstatement) left, but the new stuff is mostly at [MetricsDAO](https://metricsdao.xyz/) — check it out, accept a challenge, submit your work, and get paid!
+

our-app/keyboard-shortcuts.md

@@ -0,0 +1,54 @@
+---
+description: >-
+  These are the default shortcuts available via our open-source code editor
+  component CodeMirror
+---
+
+# Keyboard Shortcuts
+
+Note: not _all_ of these have been tested, so please use with caution. If you notice something not working as expected, or out of place, please let us know in [Discord](https://discord.gg/ZmU3jQuu6W).
+
+| Function                                         | Windows                               | Linux                                 | Mac                                   | Notes                                                                                                                |
+| ------------------------------------------------ | ------------------------------------- | ------------------------------------- | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| Delete Line                                      | ctrl + shift + k                      | ctrl + shift + k                      | cmd + shift + k                       |                                                                                                                      |
+| Move Line Up / Down                              | alt + up or down                      | alt + up or down                      | option + up or down                   |                                                                                                                      |
+| Duplicate Line Above / Below                     | shift + alt + up or down              | shift + alt + up or down              | shift + option + up or down           |                                                                                                                      |
+| Cut line                                         | ctrl + x                              | N/A                                   | cmd + x                               |                                                                                                                      |
+| Cut selection                                    | ctrl + x                              | ctrl + x                              | cmd + x                               |                                                                                                                      |
+| Copy line (nothing selected)                     | ctrl + c                              | N/A                                   | cmd + c                               |                                                                                                                      |
+| Copy selection                                   | ctrl + c                              | ctrl + c                              | cmd + c                               |                                                                                                                      |
+| Paste                                            | ctrl + v                              | ctrl + v                              | cmd + v                               |                                                                                                                      |
+| Select rest of line from cursor                  | ctrl + shift + down                   | ctrl + shift + down                   | ctrl + shift + e                      |                                                                                                                      |
+| Delete next character                            | del                                   | del                                   | ctrl + d                              |                                                                                                                      |
+| Backspace whole word                             | ctrl + backspace                      | ctrl + backspace                      | option + backspace                    |                                                                                                                      |
+| Delete line from cursor                          | N/A                                   | N/A                                   | ctrl + k                              | Deletes to end of line from current cursor location.                                                                 |
+| Select current line                              | alt + l                               | alt + l                               | ctrl + l                              | Continuing to press will select the next line down                                                                   |
+| Move single char forward                         | N/A                                   | N/A                                   | ctrl + t                              | This will take the character directly behind the cursor and move it forward 1 spot for each press. Useful for typos. |
+| Select single line above starting from cursor    | N/A                                   | N/A                                   | ctrl + shift + p                      |                                                                                                                      |
+| Select single line below starting from cursor    | N/A                                   | N/A                                   | ctrl + shift + n                      |                                                                                                                      |
+| Backspace line from cursor                       | N/A                                   | ctrl + shift + backspace              | cmd + delete                          |                                                                                                                      |
+| Delete only commented text                       | alt + backspace                       | N/A                                   | N/A                                   | This will leave uncommented text untouched                                                                           |
+| Toggle line comment                              | ctrl + /                              | ctrl + /                              | cmd + /                               |                                                                                                                      |
+| Toggle block comment                             | shift + alt + a                       | shift + alt + a                       | shift + option + a                    |                                                                                                                      |
+| Open suggestion dropdown                         | ctrl + space                          | ctrl + space                          | ctrl + space                          |                                                                                                                      |
+| Move sidebar to other side of editor             | ctrl + shift + x                      | ctrl + shift + x                      | N/A                                   |                                                                                                                      |
+| Escape button                                    | Esc                                   | Esc                                   | Esc                                   |                                                                                                                      |
+| Run Query                                        | ctrl + enter                          | ctrl + enter                          | cmd + return                          |                                                                                                                      |
+| Create new line above                            | N/A                                   | N/A                                   | ctrl + o                              |                                                                                                                      |
+| Indent / outdent line                            | ctrl + ] or \[                        | ctrl + ] or \[                        | cmd + ] or \[                         |                                                                                                                      |
+| Go to matching bracket                           | ctrl + shift + \\                     | ctrl + shift + \\                     | cmd + shift + \\                      | When cursor is on an open or close bracket (Velocity will show it as green/lightly highlighted)                      |
+| Go to beginning of line                          | Home                                  | Home                                  | fn + left                             |                                                                                                                      |
+| Go to end of line                                | End                                   | End                                   | fn + right                            |                                                                                                                      |
+| Go to beginning of file                          | ctrl + Home                           | ctrl + Home                           | shift + option + <                    |                                                                                                                      |
+| Go to end of file                                | ctrl + End                            | ctrl + End                            | shift + option + >                    |                                                                                                                      |
+| Collapse / uncollapse region                     | ctrl + shift + \[ or ]                | ctrl + shift + \[ or ]                | cmd + option + \[ or ]                | When a \\/ carrot appears next to the line number, the related query lines can be collapsed                          |
+| Search and Replace                               | ctrl + f                              | ctrl + f                              | cmd + f                               | If user has text highlighted when using this command, it will search for the selection.                              |
+| Search for next                                  | ctrl + g                              | ctrl + g                              | cmd + g                               | If user has nothing selected, search bar will pop up. If user has a selection, cursor will jump to next instance.    |
+| Undo cursor move                                 | ctrl + u                              | ctrl + u                              | cmd + u                               | If user clicks somewhere else, this will bring the cursor back to where it just was                                  |
+| Select next character / grow or shrink selection | shift + right or left                 | shift + right or left                 | shift + right or left                 | User can start a selection or use this shortcut to expand a current selection                                        |
+| Select next word / block                         | shift + (ctrl OR alt) + right or left | shift + (ctrl OR alt) + right or left | shift + (ctrl OR alt) + right or left | User can start a selection or use this shortcut to expand a current selection                                        |
+| Select all                                       | ctrl + a                              | ctrl + a                              | cmd + a                               |                                                                                                                      |
+| Go to line prompt                                | alt + g                               | alt + g                               | option + g                            |                                                                                                                      |
+| Move cursor full word / block                    | ctrl + left or right                  | ctrl + left or right                  | option + left or right                |                                                                                                                      |
+
+\

our-data/labels/README.md

@@ -8,15 +8,11 @@ description: >-
 
 Labels identify known addresses that are associated with a CEX, DEX, NFT project, liquidity pool, or other entity. 
 
-How are labels different from tags?\
-\
-Labels are a "source of truth" added by Flipside core contributors across all chains.\
-\
-Each known address receives only one label. Not every address has a label.
-
-``[`crosschain.core.address_labels` table docs](../archive/tables/crosschain-tables/crosschain-address-labels.md)
+How are labels different from tags? Labels are a "source of truth" added by Flipside core contributors across all chains. Each known address receives only one label. Not every address has a label.
 
+## Contribute to our labels
 
+To contribute to our labels, go to our [label submission form](https://science.flipsidecrypto.xyz/add-a-label/) and follow the steps there to submit a label. We will review all submitted labels and add accurate labels to our tables. Be sure to add a discord handle so we can reach out to you if there are any questions!
 
 ## Label Types
 
@@ -63,9 +59,5 @@ event_from_label
 event_from_address_name
 ```
 
-## Contribute to our labels
 
-To contribute to our labels, go to our [label submission form](https://science.flipsidecrypto.xyz/add-a-label/) and follow the steps there to submit a label. We will review all submitted labels and add accurate labels to our tables. \
-\
-Be sure to add a discord handle so we can reach out to you if there are any issues with your submitted labels.