Skip to content

docs(oracles): drop emoji and question headings and generalise the emoji rule #2364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GigaHierz merged 2 commits into from
Oct 6, 2026
Merged

docs(oracles): drop emoji and question headings and generalise the emoji rule #2364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a83310c
docs: replace the rocket emoji in the banner and oracle headings, and…
GigaHierz Oct 2, 2026
6ebf520
docs(oracles): drop the remaining emoji and question headings and gen…
GigaHierz Oct 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ Use these names exactly (they are the most common ones in the repo; synonyms lik
- Document what is true now. No "recently", "as of the L2 migration", "previously", "coming soon", "roadmap". Change history belongs in Notices and release notes; planned work is not documented until it ships.
- Never invent a technical detail. If you do not know an address, flag, endpoint, env var or command, look it up (this repo, the source repo, the live chain) or say you do not know. Addresses are checked against the chain (`eth_call` / `eth_getCode`) before they land, not copied from memory or from another page.
- No inflated adjectives ("seamless", "robust", "powerful", "comprehensive", "leading"), no unsourced superlatives ("the only production-ready…"), no rule-of-three padding, no promotional framing.
- No emoji in headings or body copy. A banner may open with one emoji that fits its subject, but never a rocket.
- No comparisons that position Celo against another chain or product ("the equivalent of X on Y"). Describe what Celo does.
- Link jargon on first use on introductory pages — ERC-20, EVM, EOA, facilitator, base units — or replace it with the plain word.
- Callouts: `Note`, `Tip`, `Info`, `Warning` components only. Never `>` blockquotes for callouts.
Expand Down
16 changes: 5 additions & 11 deletions build/tools/oracles/quex-oracles.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This document covers:
- How to use Quex oracles?
- Examples

## 🚀 What is Quex?
## About Quex

@palango palango Oct 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as on RedStone: lines 9-13 list "What is Quex?" and "How to use Quex oracles?", which no longer match the headings. I'd drop the list.


Quex is an oracle protocol designed to securely transfer verifiable off-chain data to on-chain smart contracts using confidential computing proofs. Quex oracles enable apps on Celo to securely and reliably access real-world data, allowing developers to create advanced, trust-minimized financial applications, parametric tokens, prediction markets, and more.

Expand All @@ -25,28 +25,22 @@ Key benefits of using Quex:

You can explore more about Quex on the [official documentation page](https://docs.quex.tech).

## 📈 What data is available?
## Available data

Unlike traditional oracles, Quex allows you to securely make verifiable API calls to virtually any off-chain data source, including private APIs protected by credentials. This means you can literally access the entire internet with no limitations!

## 🔥 How to use Quex oracles?

IMPORTANT: Quex contracts are currently undergoing security audits and infrastructure security improvements. Before using Quex oracles in production apps, please reach out to us [on Discord](https://discord.com/invite/NsuE32xHvj). We'll be happy to assist you with the integration and, if needed, set up a dedicated data oracle pools if there is a need.

Please refer to this [short documentation](https://docs.quex.tech/consumer/getting_started/) to learn how to integrate your app with Quex oracles.

## 🔥 How to use Quex oracles?
## Use Quex oracles

IMPORTANT: Quex contracts are currently undergoing a security audit, and we are actively working on infrastructure security improvements. Before using Quex oracles in production apps, please reach out to us [on Discord](https://discord.com/invite/NsuE32xHvj). We’ll be happy to assist you with integration and, if necessary, set up a dedicated pool of data provider nodes.

Please read this [short getting started guide](https://docs.quex.tech/consumer/getting_started/) to learn how to integrate your app with Quex oracles.

## 👨‍💻 Code examples
## Code examples

- [SDK Repository](https://github.com/quex-tech/quex-v1-interfaces)
- [Examples Repository](https://github.com/quex-tech/quex-v1-examples)
- [Parametric Token Emission Example](https://github.com/quex-tech/quex-v1-examples/tree/main/tvl-emission)

## 🙋‍♂️ Need help?
## Support

Feel free to reach out to the Quex team [on Discord](https://discord.com/invite/NsuE32xHvj) if you have any questions.
10 changes: 5 additions & 5 deletions build/tools/oracles/redstone.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This document will cover:
- How to use RedStone?
- Examples

## 🚀 What is RedStone?
## About RedStone

@palango palango Oct 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The list on lines 9-13 still names the old question headings. I'd drop it, since the headings follow right below.


RedStone is a data ecosystem that delivers fast and accurate financial information in a decentralised fashion using an innovative approach of on-demand data fetching.

Expand All @@ -25,24 +25,24 @@ RedStone offers a radically different design of Oracles catering for the needs o

You can read much more about the RedStone protocol [in the RedStone compiled documentation.](https://github.com/redstone-finance/redstone-oracles-monorepo)

## 📈 What data is available
## Available data

Thanks to our innovative architecture, we offer more than one thousand of pricing data feeds, including tokens, stocks, ETFs, commodities, and much more for a fraction of regular Oracles integration costs.

You can check available assets and data providers using [app.redstone.finance.](https://app.redstone.finance/)

## 🔥 How to use RedStone?
## Use RedStone oracles

@palango palango Oct 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 40 in this section still starts with "💡 Note:". With the new AGENTS.md rule that's emoji in body copy, and section 4 says callouts use <Note>. Something like <Note>RedStone works only with ethers.js, so on Celo use ethers.js together with @celo-tools/celo-ethers-wrapper.</Note> would cover both.


**IMPORTANT**: RedStone contracts are still undergoing security audit and we are working on the infrastructure secutiry improvements. So, before using RedStone oracles in production apps, please reach out to us [on Discord.](https://redstone.finance/discord) We will be happy to help you with the integration and will set up a new pool of data provider nodes if there is a need.

Please read this [short documentation](https://github.com/redstone-finance/redstone-evm-connector/blob/master/README.md) to learn how to integrate your app with RedStone oracles.

💡 Note: currently RedStone is integrated only with `ethers.js` library, so in order to use it on Celo blockchain apps you should use [ethers.js](https://docs.ethers.io/v5/) along with [@celo-tools/celo-ethers-wrapper](https://www.npmjs.com/package/@celo-tools/celo-ethers-wrapper).

## 👨‍💻 Code examples
## Code examples

- [Synthetic commodities app on Celo](https://github.com/redstone-finance/komodo-celo)

## 🙋‍♂️ Need help?
## Support

Please feel free to contact RedStone team [on Discord](https://redstone.finance/discord) if you have any questions.
2 changes: 1 addition & 1 deletion build/tools/oracles/supra.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebarTitle: "Using Supra"

---

## 🚀 What is Supra?
## About Supra

[Supra](https://supra.com) provides decentralized oracle price feeds that can be used for on-chain and off-chain use-cases such as spot and perpetual DEXes, lending protocols, and payments protocols. Supra’s oracle chain and consensus algorithm makes it the fastest-to-finality oracle provider, with layer-1 security guarantees. The pull oracle has a sub-second response time. Aside from speed and security, Supra’s rotating node architecture gathers data from 40+ data sources and applies a robust calculation methodology to get the most accurate value. The node provenance on the data dashboard also provides a fully transparent historical audit trail. Supra’s Distributed Oracle Agreement (DORA) paper was accepted into ICDCS 2023, the oldest distributed systems conference.

Expand Down
Loading