Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Much readable documentation #8

Open
abiriadev opened this issue Jun 2, 2024 · 1 comment
Open

Much readable documentation #8

abiriadev opened this issue Jun 2, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@abiriadev
Copy link
Owner

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:

  • Allows us to provide JSDoc comments for each field.
  • Prevents type expansion.

However, it also comes with the following drawbacks:

  • We need to update the type definitions every time the schema changes.
@abiriadev abiriadev self-assigned this Jun 2, 2024
@abiriadev abiriadev added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 2, 2024
@abiriadev
Copy link
Owner Author

Also see #14

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Todo
Development

No branches or pull requests

1 participant