adds Sunset language and offramp for sub/showcase (#60)

* adds info re ability to remove showcase/subsid feeds

* fixes formatting issues

* fixes bare url issue

* adds dependabot.yml

* reorganizes content according to review

* removes subsidized feed list

* incorporates Ross edits

* incorporates edits

Author: Christian-MK

Diff for: docs/orcfax-feeds/feed-overview.md

@@ -6,41 +6,23 @@ slug: /feed-overview
 
 # Available feeds
 
-|   [ADA-USD][adausd]   |  [ADA-BTC][adabtc]  |  [ADA-iUSD][adaiusd]  | [ADA-DJED][adadjed] |  [ADA-USDM][adausdm]  |
-| :-------------------: | :-----------------: | :-------------------: | :-----------------: | :-------------------: |
-|  [AGIX-ADA][agixada]  | [BOOK-ADA][bookada] |   [BTC-USD][btcusd]   |  [BTN-ADA][btnada]  | [CERRA-ADA][cerraada] |
-|  [COPI-ADA][copiada]  | [FACT-ADA][factada] | [HOSKY-ADA][hoskyada] | [HUNT-ADA][huntada] |  [INDY-ADA][indyada]  |
-| [LENFI-ADA][lenfiada] |   [LQ-ADA][lqada]   |   [MIN-ADA][minada]   | [SHEN-ADA][shenada] |  [SNEK-ADA][snekada]  |
-|  [WMTx-ADA][wmtxada]  | [CBLP-ADA][cblpada] |                       |                     |                       |
-
-[adabtc]: https://explorer.orcfax.io/feeds/CER/ADA-BTC
-[adadjed]: https://explorer.orcfax.io/feeds/CER/ADA-DJED
-[adaiusd]: https://explorer.orcfax.io/feeds/CER/ADA-iUSD
-[adausd]: https://explorer.orcfax.io/feeds/CER/ADA-USD
-[adausdm]: https://explorer.orcfax.io/feeds/CER/ADA-USDM
-[agixada]: https://explorer.orcfax.io/feeds/CER/AGIX-ADA
-[bookada]: https://explorer.orcfax.io/feeds/CER/BOOK-ADA
-[btcusd]: https://explorer.orcfax.io/feeds/CER/BTC-USD
-[btnada]: https://explorer.orcfax.io/feeds/CER/BTN-ADA
-[cerraada]: https://explorer.orcfax.io/feeds/CER/CERRA-ADA
-[copiada]: https://explorer.orcfax.io/feeds/CER/COPI-ADA
-[factada]: https://explorer.orcfax.io/feeds/CER/FACT-ADA
-[hoskyada]: https://explorer.orcfax.io/feeds/CER/HOSKY-ADA
-[huntada]: https://explorer.orcfax.io/feeds/CER/HUNT-ADA
-[indyada]: https://explorer.orcfax.io/feeds/CER/INDY-ADA
-[lenfiada]: https://explorer.orcfax.io/feeds/CER/LENFI-ADA
-[lqada]: https://explorer.orcfax.io/feeds/CER/LQ-ADA
-[minada]: https://explorer.orcfax.io/feeds/CER/MIN-ADA
-[shenada]: https://explorer.orcfax.io/feeds/CER/SHEN-ADA
-[snekada]: https://explorer.orcfax.io/feeds/CER/SNEK-ADA
-[wmtxada]: https://explorer.orcfax.io/feeds/CER/WMTx-ADA
-[cblpada]: https://explorer.orcfax.io/feeds/CER/CBLP-ADA
+Currently, Orcfax provides support for CER type feeds. Integrators may review
+the full list of available feeds for both [mainnet][mainnet] and
+[preview][preview].
+
+<!-- we should also consider where we might point integrators to if available
+feeds becomes different from what is being showcased or subsidized -->
+
+[mainnet]:
+    https://github.com/orcfax/cer-feeds/blob/main/feeds/mainnet/cer-feeds.json
+[preview]:
+    https://github.com/orcfax/cer-feeds/blob/main/feeds/preview/cer-feeds.json
 
 ## Current Exchange Rate feeds
 
-Orcfax offers Current Exchange Rate ([CER][cer-1]) feeds that publish statements
-regarding the current price of a given currency against another. This includes
-feeds such as ADA-USD and FACT-ADA.
+Current Exchange Rate ([CER][cer-1]) feeds publish statements relating to the
+current price of a given currency against another. Feeds of this type include
+ADA-USD and FACT-ADA.
 
 For a feed of type CER, the naming convention is
 [\{\{base-currency\}\}-\{\{quote-currency\}\}][cer-2].
@@ -53,77 +35,116 @@ For a feed of type CER, the naming convention is
 
 :::
 
-[cer-1]: https://glossary.orcfax.io/#cer
-[cer-2]: https://glossary.orcfax.io/#baseQuote
+The price values published by these feeds are derived from centralized exchange
+([CEX][cex-1]) data or decentralized exchange ([DEX][dex-1]) data.
 
-### Feeds derived from CEXes
+For CEX based feeds, fiat currency names follow [ISO 4217][cex-2] and ordering
+follows [forex][cex-3] conventions where applicable. In all other cases,
+ordering defers to how pairs appear on the centralized or decentralized
+exchanges.
 
-The price values published by these feeds are derived entirely from centralized
-exchange ([CEX][cex-1]) data.
+:::info
 
-Fiat currency names follow ISO [4217][cex-2] and Ordering follows [forex][cex-3]
-convention where applicable. In other cases, such as for crypto base currencies,
-ordering defers to how the pairs appear on CEXes.
+The [Glossary][glossary] provides more information on the terminology and
+standard adopted by Orcfax.
 
+:::
+
+[cer-1]: https://glossary.orcfax.io/#cer
+[cer-2]: https://glossary.orcfax.io/#baseQuote
 [cex-1]: https://glossary.orcfax.io/#cex
+[dex-1]: https://glossary.orcfax.io/#dex
 [cex-2]: https://en.wikipedia.org/wiki/ISO_4217
 [cex-3]: https://tradenation.com/articles/base-currency-and-quote-currency/
+[glossary]: https://glossary.orcfax.io
 
-#### CEX showcase
+## Subsidized feeds
 
-In order to demonstrate the kinds of feeds derived from CEXes which integrators
-could utilize in their dApps, Orcfax is currently offering the following feeds
-as a showcase:
+There are feeds which Orcfax has identified for their broad utility across
+Cardano projects and has therefore committed to supporting their publication in
+order to aid in development initiatives. These feeds have been selected in an
+effort to provide developers with opportunities to design their solutions from
+the beginning with authentic and verifiable data as a foundation.
 
-| Feed name         | Start Date                 | End date\* |
-| ----------------- | -------------------------- | ---------- |
-| [ADA-BTC][adabtc] | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [BTC-USD][btcusd] | Sep 12th 2024 17:01:24 UTC | TBA        |
+A subsidized feed is one which Orcfax has committed to maintaining even without
+a sponsor.
 
-\*As these are showcase feeds, Orcfax makes no guarantees as to how long they
-will be offered in this capacity; integrators who would like to take advantage
-of these feeds or are interested in learning more about our services, please
-contact us via [email][email] or [Discord][discord].
+Orcfax is currently offering the following subsidized feeds:
 
-[email]: mailto:[email protected]
-[discord]: https://discord.com/invite/UbAeRuNzDu
+| Feed name | Start Date                 | End date |
+| --------- | -------------------------- | -------- |
+| ADA-USD   | Sep 12th 2024 17:01:24 UTC | TBA      |
+| FACT-ADA  | Sep 12th 2024 17:01:24 UTC | TBA      |
 
-### Feeds derived from DEXes
+when an integrator activates a subscription for a subsidized feed it will no
+longer be identified as such and will instead be labeled a
+[sponsored][sponsored] feed.
 
-The price values published through these feeds are derived entirely from
-decentralized exchange ([DEX][dex-1]) data.
+[sponsored]: #sponsored-feeds
 
-For these feeds, ordering defers to how pairs appear on DEXes.
+### Sunsetting subsidized feeds
 
-[dex-1]: https://glossary.orcfax.io/#dex
+In contrast to [showcase][showcase] feeds, subsidized feeds can be used in
+production because Orcfax has agreed to cover the cost of their support.
+
+While Orcfax has committed to maintaining access to these feeds, integrators who
+wish to utilize these feeds without a subscription should do so at their own
+risk; Orcfax still reserves the right to adjust or remove support for these
+feeds as business needs dictate. Orcfax has agreed to cover the cost of
+supporting subsidized feeds enabling them to be used in production. Changes to
+services relating to subsidized feeds will be announced three months in advance
+to provide integrators with adequate forewarning.
+
+[showcase]: #showcase-feeds
+
+## Sponsored feeds
+
+When an integrator agrees to support a given feed through a heartbeat
+publication subscription, that feed will be designated as a sponsored feed for
+the duration of that agreement.
+
+Sponsored feeds are those supported by an integrator through a subscription
+(e.g. heartbeat or deviation). Projects utilizing sponsored feeds, but are not
+paying for the feed, should do so at their own risk. Sponsors may change or
+remove support at their own discretion.
+
+Orcfax has the following sponsored feeds:
+
+| Feed name | Start Date |
+| --------- | ---------- |
+| TBA       | TBA        |
+
+## Sunsetting sponsored feeds
+
+Projects which fail to adhere to subscription agreements risk disruptions to
+their feeds.
+
+Orcfax will remove support for sponsored feeds 2 weeks after non-payment where
+there are no subscribed integrators.
+
+## Showcase feeds
+
+To demonstrate the kinds of feeds which integrators can utilize in their dApps,
+Orcfax will periodically select feeds from its catalogue and highlight them
+through publication as showcase feeds.
+
+Feeds being published and not currently listed as subsidized or sponsored are
+showcase feeds.
+
+:::warning
+
+Orcfax may change or remove support for showcase feeds at its discretion and may
+do so without notice. Integrators who would like to take advantage of these
+feeds or are interested in learning more about our services should contact us
+via [Discord][discord] or [email][email].
+
+:::
+
+[discord]: https://discord.com/invite/UbAeRuNzDu
+[email]: mailto:[email protected]
+
+## Removal of feed support
 
-#### DEX showcase
-
-In order to demonstrate the kinds of feeds derived from DEXes which integrators
-could utilize in their dApps, Orcfax is currently offering the following feeds
-as a showcase:
-
-| Feed name             | Start Date                 | End date\* |
-| --------------------- | -------------------------- | ---------- |
-| [ADA-DJED][adadjed]   | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [ADA-iUSD][adaiusd]   | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [ADA-USDM][adausdm]   | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [AGIX-ADA][agixada]   | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [BOOK-ADA][bookada]   | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [BTN-ADA][btnada]     | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [CERRA-ADA][cerraada] | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [COPI-ADA][copiada]   | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [HOSKY-ADA][hoskyada] | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [HUNT-ADA][huntada]   | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [INDY-ADA][indyada]   | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [LENFI-ADA][lenfiada] | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [LQ-ADA][lqada]       | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [MIN-ADA][minada]     | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [SHEN-ADA][shenada]   | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [SNEK-ADA][snekada]   | Sep 12th 2024 17:01:24 UTC | TBA        |
-| [WMTx-ADA][wmtxada]   | Sep 12th 2024 17:01:24 UTC | TBA        |
-
-\*As these are showcase feeds, Orcfax makes no guarantees as to how long they
-will be offered in this capacity; integrators who would like to take advantage
-of these feeds or are interested in learning more about our services, please
-contact us via [email][email] or [Discord][discord].
+Unless a feed is sponsored and paid for by a third-party, or subsidized through
+Orcfax, we may suspend or remove technical support for feeds at our own
+discretion.