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

"Why" section of the readme seems incomplete #53

Open
nspaeth opened this issue Aug 13, 2022 · 1 comment
Open

"Why" section of the readme seems incomplete #53

nspaeth opened this issue Aug 13, 2022 · 1 comment

Comments

@nspaeth
Copy link

nspaeth commented Aug 13, 2022

I expected the Why section to explain the advantages of docs-ts over alternatives like typedoc.

Why would one choose docs-ts over typedoc?

Thanks
@gcanti
Copy link
Owner

gcanti commented Aug 13, 2022

as opposed to typedoc, docs-ts is not a general purpose documentation tool, see the disclaimer in the README

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gcanti @nspaeth