Skip to content

Docs quality fixes: correctness, SEO, UX, performance#219

Merged
buddies2705 merged 24 commits into
mainfrom
docs/phase1-correctness-seo
Jul 23, 2026
Merged

Docs quality fixes: correctness, SEO, UX, performance#219
buddies2705 merged 24 commits into
mainfrom
docs/phase1-correctness-seo

Conversation

@buddies2705

@buddies2705 buddies2705 commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Correctness: localhost links, stale balance-api URLs, past-due BalanceUpdates/TokenHolders copy, Trading cube 8 → 9 chains, broken llms.txt GraphQL link
  • SEO / crawl: dedupe /docs/evm/*/docs/schema/evm/*, remove empty cube-examples.md/ + scaffold markdown-page, clean sitemap, remove duplicate Arbitrum Overview
  • Routes: /docs/authorisation/*/docs/authorization/* (redirects kept); gRPC auth path renamed similarly
  • Metadata: description on all 516 non-graphql-reference docs
  • UX: Copy MD fetches source; responsive video; typo URL renames; Authorization nav; respectPrefersColorScheme
  • Performance: demo GIFs → MP4s; self-hosted fonts (latin + latin-ext); PNG recompression (static/img ~101MB → ~38MB)

Test plan

  • /docs/authorisation/how-to-generate/ redirects to /docs/authorization/how-to-generate/
  • /docs/evm/balances/ redirects to /docs/schema/evm/balances/
  • /docs/blockchain/Arbitrum/Overview/ redirects to Arbitrum index
  • Fonts load from /fonts/*.woff2 (no fonts.googleapis.com)
  • Meta descriptions present on Start / cube / chain pages
  • Optional: yarn build

Gaurav agarwal and others added 3 commits July 23, 2026 15:01
…ions

Align Trading cube copy to 9 chains, update past-due BalanceUpdates/TokenHolders
removal messaging, replace localhost and stale balance-api links, and repair
the broken GraphQL entry in llms.txt.

Co-authored-by: Cursor <cursoragent@cursor.com>
Remove duplicate /docs/evm content (redirect to /docs/schema/evm), drop
empty cube-examples.md routes and the markdown-page scaffold, clean the
sitemap, make Copy MD fetch source (with article fallback), responsive
video player, and add Start-section title/description frontmatter.

Co-authored-by: Cursor <cursoragent@cursor.com>
Rename sandwitch/apI URLs with redirects, move Google Fonts off CSS
@import onto preconnect stylesheets, and replace the largest demo GIFs
with much smaller MP4s.

Co-authored-by: Cursor <cursoragent@cursor.com>
@buddies2705 buddies2705 changed the title Fix Phase 1 docs correctness and SEO blockers Docs quality fixes: correctness, SEO, UX, performance Jul 23, 2026
Gaurav agarwal and others added 21 commits July 23, 2026 15:09
Replace leftover GIF demos with MP4s, add meta for auth/Kafka start
pages, and point Optimism hub links at current relative doc paths.

Co-authored-by: Cursor <cursoragent@cursor.com>
Backfill title/description frontmatter on high-traffic IDE and GraphQL
pages, plus websocket/subscription guides, and correct README Docusaurus version.

Co-authored-by: Cursor <cursoragent@cursor.com>
Serve DM Sans and JetBrains Mono from /fonts, honor prefers-color-scheme,
rename Authorisation nav label to Authorization, and add description
frontmatter across cubes, GraphQL, schema, blockchain, and usecase docs.

Co-authored-by: Cursor <cursoragent@cursor.com>
Add missing title/description metadata for remaining schema, trading,
gRPC, API blog, and nested usecase pages (516/516 coverage).

Co-authored-by: Cursor <cursoragent@cursor.com>
Move docs to /docs/authorization/ (with redirects), extend self-hosted
fonts for latin-ext, and recompress large PNG screenshots (~24MB saved).

Co-authored-by: Cursor <cursoragent@cursor.com>
Delete orphan Overview page (redirect to Arbitrum index), drop the
stray blog copy file, normalize authorization link labels, and
recompress mid-size PNGs.

Co-authored-by: Cursor <cursoragent@cursor.com>
Keep generated GraphQL reference out of crawlers (already sitemap-excluded)
and correct latency/reliability typos on the Kafka concepts page.

Co-authored-by: Cursor <cursoragent@cursor.com>
Point migrated /docs/examples/{dextrades,token-holders,Base} links at
current blockchain docs, add redirects for common leftovers, and shrink
large demo MP4s further.

Co-authored-by: Cursor <cursoragent@cursor.com>
Correct Solana Pumpfun URLs that omitted the Pumpfun/ segment, and
preload DM Sans woff2 files for faster first paint.

Co-authored-by: Cursor <cursoragent@cursor.com>
Long-cache self-hosted fonts and hashed assets; keep /img/ at one week
with stale-while-revalidate so in-place media updates still refresh.

Co-authored-by: Cursor <cursoragent@cursor.com>
Replace dead evm/token-holders sidebar entry, normalize /docs/*.md links,
fix image paths and content typos, hide empty patterns scaffold, rename
sandwich demo asset, and load Chatbase only in production builds.

Co-authored-by: Cursor <cursoragent@cursor.com>
Drop .md suffixes on sibling links in data-lake and BSC memerush docs
so they match trailingSlash routes.

Co-authored-by: Cursor <cursoragent@cursor.com>
Point stale paths (how-to-guides-index, graphql intro/performance/aggregation, Tracing examples, TON/opBNB, stablecoin .md URLs) at live pages and add redirects for bookmarked URLs.

Co-authored-by: Cursor <cursoragent@cursor.com>
Correct Uniswap/DEXScreener/Jupiter related paths, TradingView and gRPC filter links, remove a nonexistent Base validator page, and add redirects for the old URLs.

Co-authored-by: Cursor <cursoragent@cursor.com>
Point Meteora related docs at live Solana pages, restore Crypto Price and Polymarket section URLs via sidebar/category slugs, and redirect old dextrades/token-holders/graphql-reference paths.

Co-authored-by: Cursor <cursoragent@cursor.com>
Correct Practises/practise/recomended/occured/seperate/stratergies typos, keep the Kafka best-practices anchor stable, and switch learning-path, streams, and intro hubs to same-origin /docs/ links.

Co-authored-by: Cursor <cursoragent@cursor.com>
…hatbase

Convert same-origin docs URLs to /docs/, drop duplicate MDX SEO head blocks (keep JSON-LD), rewrite thin descriptions, defer Chatbase until interaction/idle, and normalize leftover British spelling.

Co-authored-by: Cursor <cursoragent@cursor.com>
Make titles and descriptions unique, keyword-led, and complete sentences (titles ≤60 chars, descriptions 120–155) across non-reference docs.

Co-authored-by: Cursor <cursoragent@cursor.com>
Point Arbitrum Overview redirect at the live hub, drop case-only and duplicate redirects that break builds, and repair broken internal links that throw on production builds.

Co-authored-by: Cursor <cursoragent@cursor.com>
Canonicalize Solana Pumpfun URLs, repair stale heading fragments, add explicit slugs for metrics/tradingview, and make the authorization category redirect work.

Co-authored-by: Cursor <cursoragent@cursor.com>
Replace "/index" placeholders with proper docs plugin ids so category links resolve correctly.

Co-authored-by: Cursor <cursoragent@cursor.com>
@buddies2705
buddies2705 merged commit f14468b into main Jul 23, 2026
1 check 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

Development

Successfully merging this pull request may close these issues.

1 participant