vercel-labs / vercel-labs/json-render

Better documentation for custom implementations

Open
#36 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
16.8k
Forks
901
Avg merge
3h 14m
Merged PRs (30d)
4

Description

Hi, I love what you're doing with this, but I feel like I'm hitting a bottleneck. Trying to use it with the AI ​​SDK, but in a slightly different way than what you describe in your documentation, has become very difficult to implement correctly.

For example, in my back end, I implemented the catalog along with a tool. Besides returning the elements to be rendered, it also returns extra information for a custom iframe that renders everything.

And in the front end, I had to do this to be able to display everything correctly:

const UIContent = () => (
    <DataProvider initialData={{ form: {} }}>
      <VisibilityProvider>
        <ActionProvider handlers={actionHandlers}>
          <Renderer tree={ui.tree} registry={shadcnRegistry} />
        </ActionProvider>
      </VisibilityProvider>
    </DataProvider>
  );

Even so, I haven’t been able to obtain the results shown in the documentation. Any suggestions would be welcome, or a note about improvements to the documentation would be appreciated. :D

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the documentation's AI SDK integration example and the DataProvider, VisibilityProvider, ActionProvider, Renderer, and shadcnRegistry entry points shown in the report. Compare the documented flow with the custom catalog, tool, and iframe use case. Done means the documentation explains this custom implementation path clearly enough to reproduce the rendered result.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.