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

Document types #4002

Closed
Rich-Harris opened this issue Feb 18, 2022 · 1 comment · Fixed by #4011
Closed

Document types #4002

Rich-Harris opened this issue Feb 18, 2022 · 1 comment · Fixed by #4011
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@Rich-Harris
Copy link
Member

Describe the problem

The TypeScript section of the docs documents the App namespace, but none of the types that are exported from @sveltejs/kit or the $app modules. It would be good to have this information present in a reference (albeit human-readable — none of the incomprehensible garbage you get from stuff like typedoc by default).

In addition, we could definitely make stuff like this a bit nicer to look at:

image

Describe the proposed solution

This could take many forms, and will probably need a bit of experimentation to get right.

Alternatives considered

No response

Importance

nice to have

Additional Information

No response

@benmccann benmccann added the documentation Improvements or additions to documentation label Feb 18, 2022
@benmccann
Copy link
Member

Here's an issue showing where I got using TypeDoc: #3996

@Rich-Harris Rich-Harris mentioned this issue Feb 19, 2022
5 tasks
@benmccann benmccann added this to the 1.0 milestone Feb 20, 2022
@benmccann benmccann linked a pull request Feb 20, 2022 that will close this issue
7 tasks
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants