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.

Sign up for GitHub

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

Jump to bottom

TypeDoc #1612

Closed
carlocorradini opened this issue Jan 14, 2024 · 2 comments
Closed

TypeDoc #1612

carlocorradini opened this issue Jan 14, 2024 · 2 comments
Labels
Community 👨‍👧 Something initiated by a community Documentation 📖 Issues about docs Duplicate 🔑 This issue or pull request already exists

Comments

@carlocorradini
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Add TypeDoc to help exploring the API, and much more...
The generated documentation can be included in the website 🥳

Additional context
I've already created a branch with TypeDoc. See https://github.com/carlocorradini/type-graphql/tree/typedoc and run npm run gen:typedoc
@MichalLytek
Copy link
Owner

I don't see a point of this in that shape. It's just a DTS browser that you have to change your window from vscode to browser in order to see that. Jumping in IDE is much easier.

Without JSDoc, proper documentation and link (#17) it does not bring the needed value. We can use it when #17 is ready and it can integrate with that easily.

@MichalLytek MichalLytek added Community 👨‍👧 Something initiated by a community Documentation 📖 Issues about docs Blocked 🚫 Resolving this issue is blocked by other issue or 3rd party stuffs labels Jan 15, 2024
@carlocorradini
Copy link
Contributor Author

LGTM
Future! 🔮

@MichalLytek MichalLytek closed this as not planned Won't fix, can't repro, duplicate, stale Jan 22, 2024
@MichalLytek MichalLytek added Duplicate 🔑 This issue or pull request already exists and removed Blocked 🚫 Resolving this issue is blocked by other issue or 3rd party stuffs labels Jan 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Community 👨‍👧 Something initiated by a community Documentation 📖 Issues about docs Duplicate 🔑 This issue or pull request already exists
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@MichalLytek @carlocorradini