Skip to content

Conversation

@brionmario
Copy link
Member

Purpose

This pull request updates the documentation across multiple SDK packages to streamline quick start instructions, clarify usage, and unify license statements. Most framework-specific README files now direct users to official guides and documentation, removing in-place code samples and setup instructions. Additionally, the license section in each README is standardized for consistency.

Documentation improvements and simplification:

  • Updated the README.md files for @asgardeo/react, @asgardeo/nextjs, and @asgardeo/react-router to remove detailed setup and usage instructions, replacing them with links to official quick start guides and documentation for easier onboarding and maintenance. [1] [2] [3]
  • Removed the overview and feature documentation from packages/react/docs/README.md to further centralize documentation in external guides.

SDK usage clarification:

  • Added prominent warnings to the @asgardeo/javascript and @asgardeo/node README files, clarifying that these SDKs are framework-agnostic and should not be used directly in applications; instead, users should use dedicated framework-specific SDKs. [1] [2]

License statement unification:

  • Standardized the license statement in all affected README files to reference the Apache License, Version 2.0, and include a link to the LICENSE file. [1] [2] [3] [4] [5] [6] [7] [8]

Related Issues

  • N/A

Related PRs

  • N/A

Checklist

  • Followed the CONTRIBUTING guidelines.
  • Manual test round performed and verified.
  • Documentation provided. (Add links if there are any)
  • Unit tests provided. (Add links if there are any)

Security checks

@asgardeo-github-bot
Copy link

⚠️ No Changeset found

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go.

If these changes should result in a version bump, you need to add a changeset.

Refer Release Documentation to learn how to add a changeset.

@brionmario brionmario merged commit c270577 into asgardeo:main Dec 2, 2025
1 of 2 checks passed
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.

3 participants