Skip to content

docs: complete DX1 resources, glossary, and shared FAQ - #615

Merged
IbrahimIjai merged 4 commits into
SO4-Markets:mainfrom
0xsamuel1:feat/dx-097-100-docs-batch
Aug 25, 2026
Merged

docs: complete DX1 resources, glossary, and shared FAQ#615
IbrahimIjai merged 4 commits into
SO4-Markets:mainfrom
0xsamuel1:feat/dx-097-100-docs-batch

Conversation

@0xsamuel1

Copy link
Copy Markdown
Contributor

Summary

  • add a dependency-light apps/docs workspace that publishes printable static routes from validated MDX content
  • add the draft terms and risk disclosure, shared FAQ, alphabetical glossary, roadmap, and changelog resource pages
  • generate the landing FAQ from faq.mdx, wire the landing accordion and footer links, and fail CI when generated data drifts
  • validate frontmatter, sidebar reachability, orphan pages, internal links, glossary onward links, stable anchors, and alphabetical order
  • reconcile all three DX1 specs with the implementation and explicitly record prerequisite pages that remain deferred
  • use the validated shared RPC configuration to repair the type error already present on upstream main

Legal review

/resources/terms is intentionally marked status: draft. Its eligibility and jurisdiction section is prominently marked pending legal sign-off. It must not be treated as final legal language without maintainer and counsel approval.

Content audit

The glossary audit scans every <Term id="…"> reference used by concept pages and resolves it against a stable glossary heading. The content check also requires <Term> usage on at least three concept pages, checks alphabetical order with a case-insensitive English comparison, and verifies that every glossary definition has an onward link to an existing page.

The site audit walks both directions between content/meta.json and the MDX tree, then validates every internal route and anchor. Result: 8 reachable pages, 0 orphan pages, and 0 broken internal links.

The content-map reader paths were audited against the built site:

  1. Trader: risk → liquidation → funding and fees → terms/FAQ is walkable; quickstart and trading remain deferred because their prerequisite issues have not landed.
  2. Liquidity provider: risk and shared resources are walkable; pools onboarding remains deferred.
  3. Integrator/contributor: shared resources are walkable; local setup, architecture, and contract-client pages remain deferred.

These divergences are recorded in docs/dx_1/003_content_map.md; the PR does not claim that unbuilt pages exist.

Verification

  • bun lint
  • bun typecheck
  • bun run check:tokens
  • bun run test
  • bun run test:coverage
  • bun run build
  • bun run check:content
  • bun run check:links
  • bun run --cwd apps/docs check:faq
  • all AGENTS.md web/indexer integration commands
  • clean-room bun install --frozen-lockfile, lint, typecheck, test, and build

All commands passed locally. Existing lint/build warnings remain unchanged.

Closes #609
Closes #610
Closes #611
Closes #612

The GLV client read an optional import.meta environment value even though the network configuration already validates and exposes the required RPC URL. Using the shared configuration restores strict typechecking on main.
Publish the assigned resource pages from one validated content tree, generate the landing FAQ from that source, and make link, navigation, glossary order, and drift failures visible in CI. The DX1 specs record the currently deferred prerequisite content instead of presenting unbuilt reader paths as complete.
@vercel

vercel Bot commented Aug 24, 2026

Copy link
Copy Markdown

@0xsamuel1 is attempting to deploy a commit to the Ijai's projects Team on Vercel.

A member of the Team first needs to authorize it.

@drips-wave

drips-wave Bot commented Aug 24, 2026

Copy link
Copy Markdown

@0xsamuel1 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! 🚀

Learn more about application limits

@vercel

vercel Bot commented Aug 25, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
interface-web Ready Ready Preview Aug 25, 2026 10:53am

Resolves conflicts from the GMX landing-page redesign (main) against
this PR's docs/FAQ wiring:

- routes/index.tsx: keep main's new landing component set (HeaderMenu,
  HeroSection, LaunchSection, etc.), dropping the old Navbar/Hero/
  Footer imports this PR previously used.
- ui/landing/faq-section.tsx: main introduced this file with hardcoded
  FAQ copy; rewired it to source LANDING_FAQS from faq.generated.ts
  (generated from apps/docs/content/resources/faq.mdx) instead, and
  removed the now-superseded faq.tsx. faq.test.tsx renamed to
  faq-section.test.tsx to match.
- ui/landing/footer.tsx: main deleted the footer component entirely as
  part of the redesign (no footer anywhere in the new landing page).
  Accepted the deletion rather than reintroducing an old-design footer.
- e2e/landing-a11y-check.spec.ts: updated the FAQ trigger selector from
  main's hardcoded question text to the generated FAQ's first entry.
@IbrahimIjai
IbrahimIjai merged commit 7f397d5 into SO4-Markets:main Aug 25, 2026
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants