DX-065/066/077/080 — docs contribution guide, home page, oracles concept, and product guides - #640
Merged
IbrahimIjai merged 10 commits intoAug 31, 2026
Conversation
|
@bade22brazy is attempting to deploy a commit to the Ijai's projects Team on Vercel. A member of the Team first needs to authorize it. |
DX-065. apps/docs/CONTRIBUTING.md covers where content lives, the frontmatter contract, adding a page to meta.json, which checks to run, the voice rules that prose lint enforces, and previewing locally. Refs SO4-Markets#577
DX-065. The three page shapes from content map §5, in apps/docs/templates/ so they are outside the content tree that check:content scans. Each carries valid frontmatter and the section skeleton for its shape. Refs SO4-Markets#577
DX-065. .github/PULL_REQUEST_TEMPLATE/documentation.md mirrors the content map §4 definition of done, including a per-claim source-file table. The reviewer checklist is scoped to accuracy and reader fit, not style. Refs SO4-Markets#577
…and AGENTS.md DX-065. Both the human and the agent contribution contracts now point at apps/docs/CONTRIBUTING.md for documentation pull requests. Refs SO4-Markets#577
DX-080. /guides/faucet: claiming testnet tokens, the per-token cooldown the faucet contract enforces in ledgers (error code 6 / ClaimTooSoon), and the failure paths. Sourced from apps/web/src/features/faucet. Refs SO4-Markets#592
DX-077. /concepts/oracles: the real source priority in fetchTokenPrices (SO4 oracle service, then Pyth, then Binance, then GMX, then static dummy prices), fallback triggers, the 5s/30s staleness thresholds, and the unhandled all-sources-down case. Sourced from apps/web/src/features/trade/lib/oracle.ts. Refs SO4-Markets#589
DX-080. /guides/pools: the three GM markets, what a deposit is exposed to (trader PnL, long-token price, funding), the two-step keeper-executed deposit and withdrawal flow, and a worked share-value example. Sourced from apps/web/src/features/pools. Refs SO4-Markets#592
DX-080. /guides/earn: the portfolio and rewards views, SO4 staking and unstaking, on-chain reward accrual, and claim versus compound versus vesting. Sourced from apps/web/src/features/earn/lib/earn.ts. Refs SO4-Markets#592
DX-080. /guides/referrals: the three affiliate tiers with their exact volume thresholds, the flat 5% trader discount, and the 5/10/15% affiliate commission. Sourced from apps/web/src/features/referrals/data/tiers.ts. Refs SO4-Markets#592
DX-066. /index becomes a three-reader router — trader, liquidity provider, integrator — each with one destination and a sentence on who it is for, plus a popular-pages row and links to search, the changelog, and the repository. No marketing copy. Refs SO4-Markets#578
bade22brazy
force-pushed
the
docs/dx1-contributing-home-oracles-guides
branch
from
August 31, 2026 00:30
85126ae to
dfa0abe
Compare
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
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.
Implements the four DX1 documentation issues. 10 commits: DX-065 first (the contract the other 74 content issues depend on), then DX-066/077/080.
DX-065 — contribution guide and templates (#577)
apps/docs/CONTRIBUTING.md— where content lives, the line-based frontmatter contract (title≤ 60,description50–160, ISOupdated,status), adding a page tocontent/meta.json, the three checks (check:content,check:links,lint:prose) and where CI runs them, the prose rules the linter enforces, previewing withbun run --cwd apps/docs dev, and the sourcing requirement.apps/docs/templates/{concept,guide,reference}.mdx— the three shapes from content map §5. Placed outsidecontent/socheck:contentdoes not treat them as orphan pages; each carries valid frontmatter and the section skeleton for its shape..github/PULL_REQUEST_TEMPLATE/documentation.md— mirrors the content map §4 definition of done, with a per-claim source-file table and the "every documented action performed on testnet" confirmation for guides.apps/docs/REVIEWER_CHECKLIST.md— scoped to accuracy and reader fit; explicitly defers style tolint:prose/ DX-053.CONTRIBUTING.mdandAGENTS.mdboth link toapps/docs/CONTRIBUTING.md.DX-066 — docs home page (#578)
apps/docs/content/index.mdxreplaces the placeholder with a three-door router: trade → quickstart + liquidation, provide liquidity → the pools guide, integrate → architecture + local setup + oracles. Each door names its reader. Plus a popular-pages row and links to search (Cmd/Ctrl + K), the changelog, and the repository. No marketing copy./indexis exempt from the sidebar orphan check.DX-077 — /concepts/oracles (#589)
Sourced from
apps/web/src/features/trade/lib/oracle.ts,.../lib/pyth.ts, and.../components/OracleStalenessIndicator.tsx:fetchTokenPrices()tries the SO4 oracle service first, then Pyth Hermes, then Binance REST, then the GMX oracle, then a staticDUMMY_PRICESarray. The page flags that this diverges from the "Binance primary, GMX fallback" summary.try/catch; throw or empty result → next source; no retry, no health scoring).fresh< 5s,warning5–30s,stale> 30s.min/maxspread exists and points to/concepts/liquidationandoracle.tsconsumers rather than guessing the selection rule.DX-080 — pools, earn, referrals, faucet guides (#592)
/guides/faucet—claim_many, the singlecooldown_ledgersvalue tracked per account and per token, error code 6 (ClaimTooSoon) surfaced as the cooldown message, and that the UI shows a last-claim ledger number, not a countdown. Sources:apps/web/src/features/faucet/{hooks/useClaim.tsx,hooks/useFaucetData.ts,data/tokens.ts}./guides/pools— the three GM markets (features/pools/data/markets.ts), unified-liquidity exposure, the two-step keeper-executed deposit/withdrawal (pool-actions.tsx: "~60s"), and a worked share-value example. Flags that the page's APY/TVL are hard-coded to0today (features/earn/data/pools.ts)./guides/earn— portfolio + rewards views,stakeSO4/unstakeSO4, on-chain reward accrual, claim vs compound vs vesting (features/earn/lib/earn.ts). Does not quote a reward rate — there is no constant for one in the client./guides/referrals— the exact tier table fromfeatures/referrals/data/tiers.ts: Bronze (0 USD/mo, 5% discount, 5% commission), Silver (2,500, 5%, 10%), Gold (25,000, 5%, 15%); trader discount is flat 5%. Actions fromlib/referrals.ts.Verification status
Not built or run in this environment. I emulated
check:content(frontmatter bounds, orphan/route resolution) andlint:prose(banned words, capitalisation, exclamation marks) locally against the five content pages and all pass; the real toolchain and a maintainer accuracy pass have not run. Specifically still needing a maintainer:<Mermaid>component instead of a fenced block (no content page uses<Mermaid>today).status: betaon all four.Closes #577, closes #578, closes #589, closes #592