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

Switch from jsdoc to typedoc #699

Closed
3 tasks
Tracked by #400
jeromy-cannon opened this issue Oct 17, 2024 · 6 comments · Fixed by #714
Closed
3 tasks
Tracked by #400

Switch from jsdoc to typedoc #699

jeromy-cannon opened this issue Oct 17, 2024 · 6 comments · Fixed by #714
Assignees
Labels
P1 High priority issue. Required to be completed in the assigned milestone. released

Comments

@jeromy-cannon
Copy link
Contributor

jeromy-cannon commented Oct 17, 2024

Tasks

Preview Give feedback
@jeromy-cannon jeromy-cannon added the P1 High priority issue. Required to be completed in the assigned milestone. label Oct 17, 2024
@slashexx
Copy link
Contributor

slashexx commented Oct 18, 2024

I can work on this !

@jeromy-cannon
Copy link
Contributor Author

I can work on this !

sure, go for it! thanks!

@slashexx
Copy link
Contributor

I've made a PR, requesting a review ! (#714)

  • update docs/Taskfile.yaml to leverage TypeDoc instead of jsdoc

  • verify that when running from docs directory task start (and click link to check in browser) that docs are showing up correctly under classes

  • add and configure eslint-plugin-tsdoc for ESLint

@jeromy-cannon
Copy link
Contributor Author

I've made a PR, requesting a review ! (#714)

  • update docs/Taskfile.yaml to leverage TypeDoc instead of jsdoc
  • verify that when running from docs directory task start (and click link to check in browser) that docs are showing up correctly under classes
  • add and configure eslint-plugin-tsdoc for ESLint

Thank you, @slashexx!

I'll review it today :-)

@jeromy-cannon
Copy link
Contributor Author

I've made a PR, requesting a review ! (#714)

  • update docs/Taskfile.yaml to leverage TypeDoc instead of jsdoc
  • verify that when running from docs directory task start (and click link to check in browser) that docs are showing up correctly under classes
  • add and configure eslint-plugin-tsdoc for ESLint

Thank you, @slashexx!

I'll review it today :-)

The pipeline failed. I ran it locally and got it to work better, see my suggested change.

@swirlds-automation
Copy link
Contributor

🎉 This issue has been resolved in version 0.32.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P1 High priority issue. Required to be completed in the assigned milestone. released
Projects
Status: 🆕 New
Development

Successfully merging a pull request may close this issue.

3 participants