Repository navigation
docs(oracles): drop emoji and question headings and generalise the emoji rule - #2364
Conversation
|
@eddiemessiah, this follows up your banner PR (#2361). The banner now uses 🤖 instead of 🚀, because we don't use rocket emoji in any copy. The same rule is now in AGENTS.md section 4, and I removed the rocket from three oracle page headings that had one. You can't be added as a formal reviewer on this repo, so please have a look here and say if anything is off. |
palango
left a comment
There was a problem hiding this comment.
This does what it says. git grep "🚀" at the PR head finds nothing in any file type, the docs.json change is just the banner line and merges cleanly with #2344, and nothing in the repo or the redirects links to the old what-is-… fragments, so the slug change breaks nothing.
Two small things, neither blocking. The Quex and RedStone pages still have 📈, 🔥, 👨💻 and 🙋♂️ headings a few lines below the ones you fixed, and most of them are questions, both of which AGENTS.md section 3 already rules out. Since you're in these files, could you clean those up too? Nothing links to them. And I'd make the new AGENTS.md line more general, see the inline comment.
| - 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 rocket emoji in any copy: pages, headings, banners or PR text. If a banner needs an emoji, use 🤖. |
There was a problem hiding this comment.
Section 3 (line 74) already bans emoji in headings, so this mostly restates it for one emoji. "PR text" isn't page copy, and this file is served as a public page on docs.celo.org. Pinning 🤖 fits the current banner but would read oddly on one about a hardfork or an operator deadline. Something like "No emoji in body copy; a banner may open with one emoji that fits its subject" would still hold next year. Your call.
| - Examples | ||
|
|
||
| ## 🚀 What is Quex? | ||
| ## What is Quex? |
There was a problem hiding this comment.
Lines 28, 32, 38, 44 and 50 still have emoji headings, and 32 and 38 are the same section twice. Worth stripping while you're here.
| - Examples | ||
|
|
||
| ## 🚀 What is RedStone? | ||
| ## What is RedStone? |
There was a problem hiding this comment.
Same here: lines 28, 34, 42 and 46 still have emoji headings.
dd7b9ce to
168696b
Compare
|
Both points are in 168696b, and the branch is rebased onto
The banner change itself is no longer in this PR, because |
palango
left a comment
There was a problem hiding this comment.
Both points from last time are handled. The oracle headings are clean, the duplicate Quex section is gone, and the AGENTS.md line now holds beyond this banner. Nothing in the repo links to the old heading slugs, and this merges cleanly with #2368: the AGENTS.md hunks don't overlap and git follows the oracle renames.
Two small leftovers, both optional. RedStone line 40 still opens with "💡 Note:", which is now against the rule this PR adds, and section 4 wants a <Note> there anyway. And the "This document will cover" lists at the top of the Quex and RedStone pages still name the old question headings. I'd just delete them, since the headings follow right below.
|
|
||
| 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 |
There was a problem hiding this comment.
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.
| @@ -12,7 +12,7 @@ This document will cover: | |||
| - How to use RedStone? | |||
| - Examples | |||
|
|
|||
| ## 🚀 What is RedStone? | |||
| ## About RedStone | |||
There was a problem hiding this comment.
The list on lines 9-13 still names the old question headings. I'd drop it, since the headings follow right below.
| @@ -12,7 +12,7 @@ This document covers: | |||
| - How to use Quex oracles? | |||
| - Examples | |||
|
|
|||
| ## 🚀 What is Quex? | |||
| ## About Quex | |||
There was a problem hiding this comment.
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.
|
Thanks @GigaHierz, looks good to me. The diff matches the description, and I've noted the rule for all future copy. |
… add the rule to AGENTS.md Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…eralise the emoji rule Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
168696b to
6ebf520
Compare
palango
left a comment
There was a problem hiding this comment.
Re-approving. The last push only rebases onto main after the learn/ and build/ moves, and the oracle pages are identical to what I approved before, just under build/tools/oracles/. Nothing links to the old heading slugs and CI is green.
The two optional leftovers from last time are still open if you want them: the "💡 Note:" on RedStone line 40, and the "This document will cover" lists at the top of the Quex and RedStone pages. Fine to merge without them.
Follow-up to #2361: no rocket emoji, and no emoji headings, on the oracle pages.
The banner already opens with 🤖 on
main, so this PR no longer touchesdocs.json.What changed
tooling/oracles/{supra,redstone,quex-oracles}.mdx: removes every emoji from the headings and turns the question headings into noun phrases (About X, Available data, Use X oracles, Code examples, Support), per AGENTS.md section 3. Nothing links to the old anchors.quex-oracles.mdxhad the "How to use Quex oracles" section twice, with slightly different wording. I kept the later one (it names both the audit and the infrastructure work and links the getting-started guide) and removed the first.AGENTS.mdsection 4: "No emoji in headings or body copy. A banner may open with one emoji that fits its subject, but never a rocket."git grep "🚀"over*.mdxand*.jsonreturns nothing.Verification
Overlap
#2368 moves
tooling/oracles/*tobuild/tools/oracles/*. Whichever of the two merges second needs a rebase; git follows the rename.🤖 Generated with Claude Code