abiriadev / seia

:eight_pointed_black_star: Lightweight SSR framework for React Server Components
https://seia.dev
MIT License
79 stars 7 forks source link

Much readable documentation #8

Open abiriadev opened 2 months ago

abiriadev commented 2 months ago

Problem

Currently, TypeDoc does not display Zod's inferred types clearly.

image

This approach is not ideal for displaying types. Instead of expanding the types, TypeDoc should generate a link.

Solutions

One potential solution is to define our own types rather than using Zod's inferred types. This approach offers the following advantages:

However, it also comes with the following drawbacks:

abiriadev commented 2 months ago

Also see #14