docs: update docs #115
Merged
docs: update docs #115
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Updated package.json files across various packages to change homepage, bugs URL, and repository URL from "asgardeo/web-ui-sdks" to "asgardeo/javascript". - Modified CHANGELOG.md files to reflect the new repository links for pull requests and commits. - Adjusted README.md files in the react-router and vue packages to point to the new issue tracker. - Updated sample applications' CHANGELOG.md and README.md files to reference the new repository. - Changed links in Vue component files to direct to the new GitHub repository.
DilshanSenarath
approved these changes
Jul 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
This pull request introduces significant updates to the Asgardeo JavaScript SDKs repository, including a repository rebranding, documentation cleanup, and enhancements to the
README.mdfile. The most important changes involve renaming the repository references, removing outdated documentation files, and improving the onboarding experience for users.Repository Rebranding:
.changeset/config.json: Updated the repository name fromasgardeo/web-ui-sdkstoasgardeo/javascript..github/workflows/deploy-gh-pages.yml: Changed the deployment environment URL fromweb-ui-sdkstojavascript.CONTRIBUTING.md: Updated repository URLs to reflect the newasgardeo/javascriptname.Documentation Cleanup:
docs/.gitignore,docs/package.json,docs/src/.vitepress/config.mts,docs/src/.vitepress/theme/index.ts,docs/src/.vitepress/theme/style.css,docs/src/index.md) related to the oldweb-ui-sdksstructure. These files are no longer relevant to the current repository structure. [1] [2] [3] [4] [5] [6]README Enhancements:
README.md: Updated the repository banner image, added links to documentation and changelog, included quick start guides for React and Next.js, and improved the description for better onboarding. Added new badges for community engagement (e.g., StackOverflow, Discord, Twitter).README.md: Added a new package,@asgardeo/react-router, to the list of available SDKs. Updated issue reporting links to reflect the repository name change.These changes streamline the repository and enhance the user experience for developers working with Asgardeo's JavaScript SDKs.
Related Issues
Related PRs
Checklist
Security checks