Skip to content

Better jsdoc documentation #3695

Description

@roninjin10

What is the problem this feature would solve?

I find using Effect to be extremely painful for getting into a flow state. The reason for this is because I consistently need to leave my editor to figure out really basic usage information usually to search the docs or source.

This becomes more painful when using more niche libraries like effect/rpc.

With better jsdoc documentation this wouldn't be a problem.

What is the feature you are proposing to solve the problem?

Investment into JSDoc documentation complete with @example and links to the actual documentation.

What alternatives have you considered?

I have attempted to use AI as the answer to this problem but AI hallucinates or uses old APIs with Effect so much it's counter productive

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions