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

DOCS: publish API #57

Closed
jkowalleck opened this issue Jun 4, 2022 · 0 comments · Fixed by #436
Closed

DOCS: publish API #57

jkowalleck opened this issue Jun 4, 2022 · 0 comments · Fixed by #436
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jkowalleck
Copy link
Member

jkowalleck commented Jun 4, 2022 •
edited

the library implements a lot of public API.

this public API should be published/rendered. the private types/interfaces/definitions/declarations must not be published.

the package was configured to render own type definitions, already.
The documentation could be rendered from it.

options
@jkowalleck jkowalleck added the documentation Improvements or additions to documentation label Jun 4, 2022
jkowalleck added a commit that referenced this issue Jun 5, 2022
@jkowalleck
wip
ef0d69d 
work on #57

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck jkowalleck mentioned this issue Jun 5, 2022
Closed
@jkowalleck jkowalleck added this to the v1.0 milestone Jun 5, 2022
jkowalleck added a commit that referenced this issue Jun 6, 2022
@jkowalleck
wip
bd3d621 
work on #57

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck jkowalleck removed this from the v1.0 milestone Jun 19, 2022
@jkowalleck jkowalleck mentioned this issue Nov 5, 2022
Merged
2 tasks
This was referenced Jan 27, 2023
Closed
Merged
@jkowalleck jkowalleck added the enhancement New feature or request label Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: ship working TypeDoc configs CycloneDX/cyclonedx-javascript-library
1 participant
@jkowalleck