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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

馃摑 Documentation: Split API docs out from README.md #56

Closed
2 tasks done
JoshuaKGoldberg opened this issue Feb 13, 2023 · 0 comments 路 Fixed by #70
Closed
2 tasks done

馃摑 Documentation: Split API docs out from README.md #56

JoshuaKGoldberg opened this issue Feb 13, 2023 · 0 comments 路 Fixed by #70
Labels
area: documentation Improvements or additions to docs 馃摑 type: feature New enhancement or request 馃殌

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

Overview

From @RebeccaStevens' comment in #52 (comment):

Due to the share number of functions exported by this library, I think it would be better to put all these docs in an API.md file rather than cluttering up the readme. The readme can then link to that file. Each of the categories within the API docs could even be split up into sub-files to prevent the API file from becoming huge.

Agreed on splitting up. My default instinct is to create a docs/ directory, like how TypeStat's docs are. What do you think?

Additional Info

Maybe this is a precursor to creating a live site like https://tsup.egoist.dev? I wouldn't mind have a ts-api-tools.joshuakgoldberg.dev... 馃槃
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: documentation Improvements or additions to docs 馃摑 type: feature New enhancement or request 馃殌
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: add docs to functions and setup auto-generation of docs JoshuaKGoldberg/ts-api-utils
1 participant
@JoshuaKGoldberg