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

For new documentation/pages, please follow the naming conventions outlined in the 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.

Technical Specifications Template: Macros

Instructions

  1. Follow the template below. Areas that need modifications in 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 [How It Works](https://github.com/FlipsideCrypto/fsc-evm/wiki/General:-How-It-Works:-Project-Variables) guide for more details on how to access and utilize variables effectively._

---

# Overview

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

---

# <INSERT 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>

## Macro: [macro_name(args)](insert github repo link to relative macro path e.g. https://github.com/FlipsideCrypto/fsc-evm/blob/main/macros/...sql)

## Usage
* Package: `<Insert package name that the macro belongs to e.g. main_package. If the macro exists in the `/global` folder then use `global` as the package name.>`
  * Sub-package: `<Insert sub_package (category) that the macro belongs to e.g. variables if path is `macros/global/variables/return_vars.sql`. This is the name of the folder nested directly within the package.>`
* Description: <Please provide brief description of the macro>
* Arguments: <Provide bulleted notation for any arguments that might be present, including default values and behavior. Keep this condensed and technical, yet intuitive and organized.>

## Developer Notes
* <Insert key points about the macro, edge cases to account for, tips on interacting with the macro etc. here. Note: Use bulleted notation and keep the notes condensed, straight to the point, easy to understand. Do not write notes just for the sake of documentation, this section should contain crucial information only, so only include notes if necessary for the developer to understand.>

---

## Macro: <next MACRO being documented, if applicable>

## Usage

...

---

# <Insert next CATEGORY, if applicable>

## Macro: 

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