Start Here: Documentation Templates: Tech Specs: Models - FlipsideCrypto/fsc-evm GitHub Wiki

For new documentation/pages, please follow the naming conventions outlined in Updating and Maintaining the Wiki section.

To assist with the documentation process, copy/paste the following template, alongside the relevant instructions and sources (models, macros etc.) into an AI chat interface. Please double check inputs and outputs prior to saving new or updated documentation, especially if created via AI.

Technical Specifications Template: Models

Instructions

  1. Follow the template below. Areas that need updating or should be removed from the final documentation are typically marked with <...>.
  2. Use --- as the line break to indicate new sections.
  3. See here for an example.
> _Model/function variables are set and managed in each repo's `dbt_project.yml` file, or the models/functions themselves. Please see the fsc-evm installation instructions in the [README](https://github.com/FlipsideCrypto/fsc-evm/blob/main/README.md) or the [Installing fsc-evm](https://github.com/FlipsideCrypto/fsc-evm/wiki/Start-Here:-Installing-fsc-evm) guide for more details on how to access and utilize variables effectively._

---

# Overview

* <Provide brief overview of the models being documented.> 
* <This section and document should _not_ contain a guide on how to deploy, interact or manage the models. Rather, please write a [separate guide](https://github.com/FlipsideCrypto/fsc-evm/wiki/Start-Here:-Documentation-Templates:-Guides:-General-Template) for that purpose.>

---

# <INSERT SCHEMA or CATEGORY. Note, this is intended for viewership/organization purposes and does not need to be repeated below unless the schema/category changes for the following models>

## Model: [schema.table](insert github repo link to model e.g. https://github.com/FlipsideCrypto/fsc-evm/blob/main/models/...sql)

## Usage
* Description: <Please provide brief description of the model>
* Min. Requirements: 
   * Version: `<Insert minimum supported fsc-evm release version required to access this model>`
   * Package: `<Insert package name that the model belongs to e.g. main_package>`
   * Sub-package: `<Insert sub_package (category) that the model belongs to e.g. prices. This is the name of the folder nested directly within the package.>`
* Deployment Path: `<Insert path to deploy the model. This path can be used in a dbt run cmd to run the model, e.g. main_package.prices.bronze.bronze__complete_native_asset_metadata>`

## Variables

| Variable     | Type                | Default                                        | Required | Description                                                                                  |
|---------------|---------------------|------------------------------------------------|---|----------------------------------------------------------------------------------------------|
| `<INSERT_VARIABLE_1>`     | <INSERT_DATA_TYPE> | <INSERT_DEFAULT_VALUE> | <INSERT_YES_OR_NO> | <INSERT_VARIABLE_DESCRIPTION> |
| `<INSERT_VARIABLE_2>`  | <INSERT_DATA_TYPE> | <INSERT_DEFAULT_VALUE> | <INSERT_YES_OR_NO> | <INSERT_VARIABLE_DESCRIPTION> |

<_Note, if no variables or default values exist for the model, use a dash `-` for each column value. See example linked in the instructions for more details._>

---

## Model: <next MODEL being documented, if applicable>

## Usage

...

---

# <Insert next SCHEMA or CATEGORY, if applicable>

## Model: 

...
⚠️ **GitHub.com Fallback** ⚠️