Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Docs: Add generated documentation on packages exports to the site #9298

Copy link
Copy link
Closed
@JoshuaKGoldberg

Description

@JoshuaKGoldberg
Issue body actions

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

Splitting out of #8093: in addition to having a landing page for the utils and type-utils packages on the website, I think it'd be nice to additionally have generated docs on their actual exports. It's more discoverable / searchable than having to crawl through TypeScript definitions.

From #8093 (comment), I have a PoC over at https://deploy-preview-9293--typescript-eslint.netlify.app/packages/type-utils. What do you all think about having this for, say, the packages with standalone exports folks would typically use:

  • type-utils
  • utils

Affected URL(s)

https://typescript-eslint.io/packages/type-utils (once it exists)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationDocumentation ("docs") that needs adding/updatingDocumentation ("docs") that needs adding/updatinglocked due to agePlease open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.team assignedA member of the typescript-eslint team should work on this.A member of the typescript-eslint team should work on this.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.