Skip to content

feat(docs): update docs to reflect new changes - #860

Draft
multipletwigs wants to merge 10 commits into
mainfrom
bashtwigs/pro-1559-improve-documentation-for-all-providers
Draft

feat(docs): update docs to reflect new changes#860
multipletwigs wants to merge 10 commits into
mainfrom
bashtwigs/pro-1559-improve-documentation-for-all-providers

Conversation

@multipletwigs

Copy link
Copy Markdown
Collaborator

No description provided.

@linear

linear Bot commented Jul 22, 2026

Copy link
Copy Markdown

PRO-1559

@vercel

vercel Bot commented Jul 22, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
sdp-docs Ready Ready Preview Aug 3, 2026 1:07am
sdp-web Ready Ready Preview Aug 3, 2026 1:07am

Request Review

@greptile-apps

greptile-apps Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR refreshes the SDP docs with a redesigned home page, a new "Developing with SDP" navigation section, partner logo rows, inline SVG card sketches, a sidebar search button, and a Shiki transformer that animates ramp-provider names in code fences.

  • Navigation restructure: home.mdx replaced by index.mdx at the docs root; manage-api-keys and related authentication pages moved from guides/ into a new developing-with-sdp/ section; reference/ai-consumption renamed to reference/docs-for-ai with consistent slug updates across meta.json, generate-ai-resources.ts, and generate-api-docs.mjs.
  • Ramp-provider carousel: source.config.ts gains a rampProviderRotator Shiki transformer that swaps a sentinel token in flagged code fences with a 7-item CSS vertical carousel (ramp-rotator.css), cycling through provider IDs and token-op names; both rotations carry exactly 7 values matching the 7-step keyframe animation.
  • UI additions: home-sketches.tsx adds six purely declarative SVG illustrations; mdx-components.tsx adds external-link detection rendering target="_blank" rel="noreferrer" with an arrow icon; a new Orama search route wires full-text search to the docs source.

Confidence Score: 5/5

Safe to merge — the changes are docs content, UI layout, and build-time MDX transforms with no data-path or auth-critical code modified.

All href targets in the redesigned home page resolve to existing MDX files; the Shiki transformer correctly handles the 7-entry carousel with a seamless loop clone; navigation restructuring is consistently reflected across meta.json, generate scripts, and slug references.

No files require special attention.

Important Files Changed

Filename Overview
apps/sdp-docs/source.config.ts Adds a rampProviderRotator Shiki transformer that swaps a token in flagged code fences with a 7-item CSS carousel; both rotations have the required 7 entries and the seamless-loop clone is correctly wired.
apps/sdp-docs/src/components/docs-shell/home.tsx Redesigned docs home with section headings, inline SVG sketches, partner logo rows, and tutorial/AI resource cards; all internal hrefs resolve to existing pages.
apps/sdp-docs/src/styles/ramp-rotator.css New CSS for the ramp-provider carousel; keyframes step through 7 positions with a clone frame at 100% for a seamless loop, prefers-reduced-motion guard included.
apps/sdp-docs/mdx-components.tsx MDXLink now detects external URLs and renders them with target=_blank rel=noreferrer plus an ArrowUpRight icon; internal links unchanged.
apps/sdp-web/src/app/layout.tsx Adds the same react-grab dev-only CDN script as the docs layout; loads from unpkg without an SRI hash or pinned version.

Reviews (2): Last reviewed commit: "new link" | Re-trigger Greptile

Comment thread apps/sdp-docs/src/app/layout.tsx
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