API Reference for version 3.6 is broken.

[JunlinZhu-Tommy]

Checklist

• The issue can be reproduced in the nextjs-auth0 sample app (or N/A).
• I have looked into the Readme, Examples, and FAQ and have not found a suitable solution or answer.
• I have looked into the API documentation and have not found a suitable solution or answer.
• I have searched the issues and have not found a suitable solution or answer.
• I have searched the Auth0 Community forums and have not found a suitable solution or answer.
• I agree to the terms within the Auth0 Code of Conduct.

Description

https://github.com/auth0/nextjs-auth0/tree/v3.6.0?tab=readme-ov-file

All the API reference link in this readme are broken.

Reproduction

Go to the link https://github.com/auth0/nextjs-auth0/tree/v3.6.0?tab=readme-ov-file

and click any link in the API Reference.

Additional context

No response

nextjs-auth0 version

3.6.0

Next.js version

14.x

Node.js version

18.20.x

[arpit-jn]

Thanks for flagging this issue. You're right - those API reference links are broken in the v3.6.0 README.

With our focus on the v4 release, we're prioritized docs for the latest version. We'll work on fixing these links in the coming weeks, but in the meantime, here are some ways to access the v3.6.0 documentation:

Workarounds

1. Check the source code comments - The JSDoc is comprehensive.
2. Review TypeScript definitions directly.
3. Read the README and Examples - These have most of what you need.
4. Consider upgrading to v4 if possible - It has much better docs.

Migration guide: https://github.com/auth0/nextjs-auth0/blob/main/V4_MIGRATION_GUIDE.md

We appreciate your patience while we sort this out. Let us know if you have any other questions. Thanks.