Skip to content

Much readable documentation #8

@abiriadev

Description

@abiriadev

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.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Projects

Status
Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions