Skip to content

Add interactive previews and GIF assets for component docs#30

Open
itsyogesh wants to merge 1 commit intomasterfrom
docs/component-previews-and-content-updates
Open

Add interactive previews and GIF assets for component docs#30
itsyogesh wants to merge 1 commit intomasterfrom
docs/component-previews-and-content-updates

Conversation

@itsyogesh
Copy link
Owner

Summary

  • Interactive demo previews added to the 9 component doc pages that were missing them: Moment, VoteThreshold, KeyValue, VectorFixed, BTreeMap, Struct, Tuple, Vote, and Call. Each page now has a Preview/Code tab showing a live component alongside its usage snippet.
  • New demo components: advanced-demos.tsx for complex components (VectorFixed, BTreeMap, Struct, Tuple, Vote, Call) and extensions to simple-demos.tsx for Moment, VoteThreshold, and KeyValue.
  • GIF assets added to public/docs/ for component illustrations and feature walkthroughs (account input, balance input, bidirectional editing, batch calls, selectors, etc.).
  • Cross-reference links throughout the input map API reference — every row in the priority table and type reference table now links to its component doc page.
  • Content streamlining across three pages:
    • components/index.mdx — removed duplicated priority table and code block, replaced with links to the API reference.
    • getting-started.mdx — condensed the per-component descriptions into a summary paragraph pointing to the component library; replaced ASCII diagram with the bidirectional-editing GIF.
    • guide/architecture.mdx — added external links to Dedot, LunoKit, shadcn/ui; added bidirectional-editing GIF; added cross-links to component library and API reference.

Test plan

  • Run yarn dev and verify all 9 updated component doc pages render Preview/Code tabs correctly
  • Verify GIF images load on getting-started and architecture pages
  • Verify cross-reference links in the input-map API page navigate to the correct component docs
  • Confirm no build errors with yarn build

- Add live demo previews (Preview/Code tabs) to 9 component pages that
  were missing them: Moment, VoteThreshold, KeyValue, VectorFixed,
  BTreeMap, Struct, Tuple, Vote, and Call
- Create advanced-demos.tsx with demo components for VectorFixed,
  BTreeMap, Struct, Tuple, Vote, and Call inputs
- Extend simple-demos.tsx with Moment, VoteThreshold, and KeyValue demos
- Register all new demo components in page.tsx and mdx-components.tsx
- Add GIF assets to public/docs/ for component and feature illustrations
- Add cross-reference links in input-map.mdx priority table and type
  reference table, linking each component to its docs page
- Streamline components/index.mdx by removing duplicated priority table
  and type resolution code block in favor of links to the API reference
- Condense getting-started.mdx input types section to point readers to
  the component library instead of duplicating per-component descriptions
- Replace ASCII art builder diagram with bidirectional-editing GIF
- Add external links and inline references throughout architecture guide
@vercel
Copy link
Contributor

vercel bot commented Feb 27, 2026

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

Project Deployment Actions Updated (UTC)
relaycode Building Building Preview, Comment Feb 27, 2026 1:41pm

Request Review

@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 0% with 237 lines in your changes missing coverage. Please review.
✅ Project coverage is 63.74%. Comparing base (bdaedc4) to head (6005969).

Files with missing lines Patch % Lines
components/docs/demos/advanced-demos.tsx 0.00% 190 Missing ⚠️
components/docs/demos/simple-demos.tsx 0.00% 47 Missing ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.
Additional details and impacted files
@@            Coverage Diff             @@
##           master      #30      +/-   ##
==========================================
- Coverage   64.67%   63.74%   -0.93%     
==========================================
  Files         139      140       +1     
  Lines       16250    16485     +235     
  Branches     1158     1158              
==========================================
  Hits        10509    10509              
- Misses       5695     5930     +235     
  Partials       46       46              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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.

2 participants