🧭 Simplified SDEX navbar explanation#2435
Conversation
Co-authored-by: Codex <noreply@openai.com>
There was a problem hiding this comment.
Pull request overview
Updates Learn navigation and the SDEX liquidity pools doc metadata so first-time readers see “Stellar Decentralized Exchange” (and the SDEX acronym) spelled out more explicitly in the navbar and page title.
Changes:
- Expanded the doc’s
title,sidebar_label, and H1 to spell out “Stellar Decentralized Exchange”. - Updated the Learn navbar dropdown item label to “Stellar Decentralized Exchange (SDEX)”.
- Changed the doc’s
sidebar_positionvalue (which affects sidebar ordering).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/learn/fundamentals/liquidity-on-stellar-sdex-liquidity-pools.mdx | Expands SDEX/DEX naming in front matter and H1; also changes sidebar ordering via sidebar_position. |
| config/theme/navbar.ts | Updates Learn dropdown label to spell out “Stellar Decentralized Exchange (SDEX)”. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| title: "Liquidity Pools on the Stellar Decentralized Exchange: Provide Liquidity and Enable Asset Swaps" | ||
| sidebar_label: "Stellar Decentralized Exchange" | ||
| description: "Learn how liquidity pools enable trading on the Stellar Decentralized Exchange. Understand how they work, provide liquidity, and enable decentralized asset swaps on the network." | ||
| sidebar_position: 42 |
There was a problem hiding this comment.
Yes, I think this looks a lot better vertically near the Stellar Data Structures and SCP headings (they approximately match similar widths) instead of leaving this section hanging off at the end like in the PR screenshot from prod (modified).
ElliotFriend
left a comment
ElliotFriend
left a comment
There was a problem hiding this comment.
generally, this is a great fix! spelling it out more plainly is an easy clarification and a big win for readers.
i'll push back on the sidebar_position, though. i agree that it could be moved up, but i'd say it needs to be below the data structures category (not inside the category, but underneath it). generally, too, i try to "split the difference" between existing position weights, and aim for the middle. would love to see this as 50 (data structures) -> 55 (SDEX page) -> 60 (ops and transactions). gives a little more breathing room for additions/moves down the line.
Co-authored-by: Codex <noreply@openai.com>
|
That sounds good, and - bonus - now it's alphabetical in that little trio after SCP. I made the same adjustment also on the menu bar dropdown. One little bit that I'm not sure if it's intentional: the docs sidebar shows "Stellar Data Structures," whereas the navbar uses just "Data Structures." |
For readers first coming across Stellar, they may not know what the SDEX is. Other acronym concepts such as SCPU are spelled out in the menubar before having a parenthesis notation:
However, the SDEX doesn't currently receive the same treatment. It's an important concept which encompasses a lot of the network.
Along this line of thinking, this PR also spells out DEX in the page title since the acronym may be unfamiliar and is subsequently explained and defined in the actual doc page.
Lastly, this maintains the sidebar practice of spelling it out without the acronym: