Skip to content

Schema -> MD docs#25

Merged
benbrandt merged 7 commits intomainfrom
schema-to-md
Aug 26, 2025
Merged

Schema -> MD docs#25
benbrandt merged 7 commits intomainfrom
schema-to-md

Conversation

@benbrandt
Copy link
Copy Markdown
Member

@benbrandt benbrandt commented Aug 26, 2025 •
edited
Loading

I tried:

  • MCP's method of typedoc to MD, but this didn't work because of our Zod aliases, it was just replicating the crazy zod types
  • Using the typedoc zod plugin helped, but MCP is using a plugin to just generate a slimmed down MD, and throwing away the HTML that typedoc spits out, and it didn't work with the zod stuff
  • trying various json schema to html/md tools, which all failed for various reasons

This is an attempt to just generate what we need ourselves.

image

@benbrandt benbrandt force-pushed the schema-to-md branch 5 times, most recently from 8baeae3 to 5c583d7 Compare August 26, 2025 16:29
@benbrandt
Schema -> MD docs
41792e8 
Signed-off-by: Ben Brandt <benjamin.j.brandt@gmail.com>
benbrandt and others added 5 commits August 26, 2025 11:38
@benbrandt @cole-miller @agu-z
Use mintlify components
1247866 
Co-authored-by: Cole Miller <cole@zed.dev>
Co-authored-by: Agus Zubiaga <agus@zed.dev>
Signed-off-by: Ben Brandt <benjamin.j.brandt@gmail.com>
@benbrandt @agu-z
Group by side and method
918aba2 
Co-authored-by: Agus Zubiaga <agus@zed.dev>
Signed-off-by: Ben Brandt <benjamin.j.brandt@gmail.com>
@benbrandt @agu-z
Improvements to doc rendering
c3203e2 
Co-authored-by: Agus Zubiaga <agus@zed.dev>
Signed-off-by: Ben Brandt <benjamin.j.brandt@gmail.com>
@benbrandt @agu-z
Ignore wrapper untagged enums
74dd4d3 
Co-authored-by: Agus Zubiaga <agus@zed.dev>
Signed-off-by: Ben Brandt <benjamin.j.brandt@gmail.com>
@benbrandt @agu-z
Touch up formatting and spacing
c16ad07 
Co-authored-by: Agus Zubiaga <agus@zed.dev>
Signed-off-by: Ben Brandt <benjamin.j.brandt@gmail.com>
@benbrandt benbrandt marked this pull request as ready for review August 26, 2025 21:12
@benbrandt @agu-z
Make sure we have a nightly rust installed
667d3ed 
Co-authored-by: Agus Zubiaga <agus@zed.dev>
Signed-off-by: Ben Brandt <benjamin.j.brandt@gmail.com>
@benbrandt benbrandt merged commit 6b235ca into main Aug 26, 2025
2 checks passed
@benbrandt benbrandt deleted the schema-to-md branch August 26, 2025 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@benbrandt