Overview

Filename Guide

This scroll defines the naming convention for lens files. Each filename encodes domain, function, and scope.

Structure#

[domain]_[function]_[scope]_v[version].[ext]

Components#

  • Domain: lightning, cyclone, tornado, forest, glyph, protocol
  • Function: base, map, manifest, translation, overlay, event
  • Scope: us, global, mi, historical, realtime, predictive
  • Version: v1, v2, etc.
  • Extension: json, yaml, md

Examples#

  • lightning_base_us_historical_v1.json
  • cyclone_translation_global_predictive.md
  • tornado_event_f5_1974_superoutbreak.yaml
  • glyph_map_lightning.md
  • remix_manifest.yaml