docs(get-started): write /get-started/quickstart (DX-068) - #637
Merged
IbrahimIjai merged 2 commits intoAug 30, 2026
Merged
Conversation
Walk through the first SO4 testnet trade with real observed UI text:
install Freighter, connect it, switch to Testnet, fund with friendbot,
claim a test token, submit a small order, and cancel it. Two failure
callouts quote the real messages: Freighter wrong-network rejection
("Freighter is set to Main Net / The transaction you are trying to sign
is on Test Net / Signing this transaction is not possible at the
moment.") and the no-XLM toast ("Transaction failed. Please try
again."). Document the current deployment honestly: orders are recorded
but not executed into positions, so the page points readers to the
Orders tab and the Cancel action.
Bundles DX-067 (/get-started/introduction) and its README status note
because the quickstart links to the introduction and the pages must land
together for check:links to pass. Fixes two pre-existing check:content
blockers on main: headingEntries returns the answer paragraph the
glossary check needs, and the /index home page is exempted from the
sidebar orphan rule.
Verified: check:content, check:links, and prose lint on the new page all
pass (lint:prose still reports pre-existing errors in main developer
pages, unrelated to this PR). Flow executed live on a clean profile:
Freighter 5.46.0 in a fresh Chrome profile.
Closes SO4-Markets#580
|
@Ay-obami is attempting to deploy a commit to the Ijai's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
@Ay-obami Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implements DX-068 (#580): the
/get-started/quickstartpage for docs.so4.market — the highest-traffic page on the site, covering wallet → testnet funds → first trade.Clean-profile verification (acceptance criterion)
Every step was executed start to finish on a clean browser profile before the page was written:
Every UI string in the page was captured from that live run — no text was taken from memory or source.
What the page covers
A step-by-step procedure with numbered, TOC-linkable steps and
<Steps>blocks:The two required failure callouts quote the real messages observed live:
Honest notes about the current testnet deployment (reflected in the page)
Error(Auth, ExistingValue)), surfacing the same "Transaction failed. Please try again." toast. The page directs readers to the per-token Claim buttons, which work (~8–12 s, toast "Test token claimed")./concepts/liquidation,/concepts/funding-and-fees,/concepts/risk, and the glossary<Term>./concepts/margin-and-leverageis not implemented yet, so no dead link is emitted.Dependency — bundles DX-067 (#579)
This PR includes
/get-started/introductionand its README status note from DX-067 (#579) because the quickstart links to the introduction and the two pages must land together forcheck:linksto pass. If #579 lands separately first, this PR can be rebased to drop those files. (DX-067 is currently unmerged.)DX-069 (#581,
/get-started/wallets) is NOT a dependency and is not linked from this page (it does not exist yet). Once it lands, the "Install the Freighter wallet" step should be updated to link to/get-started/wallets.Pre-existing
mainfixes required forcheck:content(included)check:contentwas broken onmainbefore this PR:apps/docs/scripts/content.ts:headingEntriesnow returns theanswerparagraph the glossary check requires (previously crashed onentry.answer.match).apps/docs/scripts/check-content.tsandapps/docs/src/lib/content.ts: the/indexhome page is exempted from the sidebar orphan rule (it is intentionally not in the sidebar).Verification
bun run --cwd apps/docs check:content— passes (29 pages, zero orphans, alphabetical glossary)bun run --cwd apps/docs check:links— passes (29 pages, zero broken internal links)lint:prosestill reports pre-existing errors in main's developer pages, unrelated to this PR)<Steps>lists, callout asides, and the glossary<Term>link all produce valid HTMLCloses #580