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

[docs] Point typedoc at .d.ts files instead of .js #497

Merged
merged 1 commit into from
Mar 24, 2024

Conversation

MysteryBlokHed
Copy link
Member

Closes #496

TypeDoc was set to use the JavaScript files for source, meaning all JSDoc from the TypeScript files was being ignored. This PR sets it to use the TS files instead, documenting types/interfaces and using the newer JSDoc.

@MysteryBlokHed MysteryBlokHed requested a review from LeaVerou March 22, 2024 02:46
Copy link

netlify bot commented Mar 22, 2024

Deploy Preview for colorjs ready!

Name Link
🔨 Latest commit e3e88fa
🔍 Latest deploy log https://app.netlify.com/sites/colorjs/deploys/65fcf12239feaf0008be9aac
😎 Deploy Preview https://deploy-preview-497--colorjs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@MysteryBlokHed
Copy link
Member Author

If desired, I can also run build:apidocs on this PR so that the generated files are up-to-date.

Copy link
Member

@LeaVerou LeaVerou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I’m assuming you’ve checked that the result is better that way?

@MysteryBlokHed
Copy link
Member Author

Thanks! I’m assuming you’ve checked that the result is better that way?

Yeah—using this, everything is typed (unlike the screenshots in #496)

@MysteryBlokHed MysteryBlokHed merged commit 4eb1a8e into color-js:main Mar 24, 2024
5 checks passed
@MysteryBlokHed MysteryBlokHed deleted the docs/use-ts-for-docs branch March 24, 2024 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Auto-generated API docs seem not to be using TypeScript files
2 participants