docs: generate API documentation based on TSDocs - Githubissues

sidebase / nuxt-auth

Authentication built for Nuxt 3! Easily add authentication via OAuth providers, credentials or Email Magic URLs!

https://auth.sidebase.io

MIT License

1.25k stars 162 forks source link

docs: generate API documentation based on TSDocs #825

Closed zoey-kaiser closed 2 months ago

zoey-kaiser commented 2 months ago

🔗 Linked issue

closes N/A

❓ Type of change

[X] 📖 Documentation (updates to the documentation, readme or JSdoc annotations)
[ ] 🐞 Bug fix (a non-breaking change that fixes an issue)
[X] 👌 Enhancement (improving an existing functionality like performance)
[ ] ✨ New feature (a non-breaking change that adds functionality)
[ ] 🧹 Chore (updates to the build process or auxiliary tools and libraries)
[ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Generated new API docs based on the TSDoc code comments.

📝 Checklist

[ ] I have linked an issue or discussion.
[ ] I have added tests (if possible).
[ ] I have updated the documentation accordingly.