Skip to content

Add Vue quickstart guide and update documentation navigation#5988

Merged
brionmario merged 3 commits intowso2:masterfrom
kavindadimuthu:doc/vuejs-sdk
Apr 17, 2026
Merged

Add Vue quickstart guide and update documentation navigation#5988
brionmario merged 3 commits intowso2:masterfrom
kavindadimuthu:doc/vuejs-sdk

Conversation

@kavindadimuthu
Copy link
Copy Markdown
Contributor

@kavindadimuthu kavindadimuthu commented Mar 18, 2026

Purpose

This pull request adds comprehensive support for a Vue quickstart guide to the Asgardeo documentation. It introduces a new quickstart page for Vue, integrates it into the navigation, and enhances the documentation metadata and iconography for Vue-related content.

Vue Quickstart Documentation:

  • Added a detailed Vue quickstart guide (vue.md) that walks users through setting up a Vue app with Vite, installing the Asgardeo Vue SDK, implementing sign-in/sign-out, and displaying user profile information. This includes step-by-step instructions and code examples. [1] [2]

Navigation and Metadata Enhancements:

  • Updated the documentation navigation (mkdocs.yml) to include the new Vue quickstart under the SDKs section.
  • Added Vue SDK and Vue Quickstart entries with appropriate icons and hierarchy levels to the documentation metadata (base.yml). [1] [2]

Related PRs

Test environment

Security checks

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 18, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 77aa7582-8b63-46ac-97fc-cec0fbc47c8b

📥 Commits

Reviewing files that changed from the base of the PR and between 7451c9b and f015ae6.

📒 Files selected for processing (3)
  • en/asgardeo/docs/quick-starts/vue.md
  • en/asgardeo/mkdocs.yml
  • en/base.yml
✅ Files skipped from review due to trivial changes (3)
  • en/asgardeo/mkdocs.yml
  • en/base.yml
  • en/asgardeo/docs/quick-starts/vue.md

📝 Walkthrough

Walkthrough

Adds a Vue (Vite) quick-start guide and shared include, and updates documentation navigation and site metadata to register Vue SDK/quickstart entries and icons.

Changes

Cohort / File(s) Summary
Vue quick-start page & include
en/asgardeo/docs/quick-starts/vue.md, en/includes/quick-starts/vue.md
New quick-start page and shared include: front-matter using templates/quick-start.html, inline meta assembly, Vite+Vue scaffold steps, Asgardeo Vue SDK installation/configuration, example main.js/App.vue snippets, auth component usage, and run/onboarding instructions.
Docs navigation & site metadata
en/asgardeo/mkdocs.yml, en/base.yml
Added Vue entries to Connect App navigation and added Vue-related nav icons/levels in site metadata (extra.nav_icons).

Suggested labels

Team/Authentication & registration

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main changes: adding a Vue quickstart guide and updating documentation navigation to support it.
Description check ✅ Passed The description includes a comprehensive Purpose section detailing the changes, but lacks Test environment details and Security checks are unchecked.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@en/asgardeo/docs/quick-starts/vue.md`:
- Line 22: The "What's next" link currently points to the non-existent route
'/complete-guides/vue/introduction/' in the string "Try out <a href='{{
base_path }}/complete-guides/vue/introduction/' target='_blank'>{{ product_name
}} complete Vue guide</a>"; either remove this anchor entirely from that string
or update the href to an existing page (e.g., remove the
'/complete-guides/vue/introduction/' segment or point to an existing guide like
the React/Angular/Next.js equivalents), and ensure the visible text still makes
sense (or change the text to a generic "Try out other complete guides" if you
remove the Vue-specific target).

In `@en/includes/quick-starts/vue.md`:
- Around line 201-205: Replace the raw URL link
[http://localhost:5173](http://localhost:5173) with descriptive link text like
"your app's homepage" or "Local app (http://localhost:5173)" and update the
generic "[guide]({{ base_path
}}/guides/users/manage-users/#onboard-single-user)" label to something specific
such as "onboard a test user" or "manage test users guide" so both links are
descriptive and accessible; locate and edit these links in the markdown block
containing the homepage visit line and the "To try out sign-in..." paragraph.
- Around line 9-10: Replace the two bulleted items under the application setup
section with a numbered (ordered) list so the steps are clearly sequential:
change the lines that read "Sign into the {{ product_name }} Console and
navigate to **Applications > New Application**." and "Select **Single-Page
Application** and complete the wizard by providing a suitable name and an
authorized redirect URL." into "1." and "2." items respectively, keeping the {{
product_name }} variable and bolded UI labels intact and ensuring both items
remain parallel in grammar and structure.
- Line 59: Update the prose on the line containing "Make sure to stop the dev
server you started in the previous step." by replacing the shorthand "dev" with
the full word "development" so the sentence reads "Make sure to stop the
development server you started in the previous step."; locate this exact
sentence in the Asgardeo Vue SDK quick-start content and perform the one-word
substitution.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7c564762-ea17-4074-b148-d472f33a5481

📥 Commits

Reviewing files that changed from the base of the PR and between 2beb062 and f21eb85.

📒 Files selected for processing (4)
  • en/asgardeo/docs/quick-starts/vue.md
  • en/asgardeo/mkdocs.yml
  • en/base.yml
  • en/includes/quick-starts/vue.md

Comment thread en/asgardeo/docs/quick-starts/vue.md Outdated
Comment thread en/includes/quick-starts/vue.md
Comment thread en/includes/quick-starts/vue.md
Comment thread en/includes/quick-starts/vue.md
@brionmario brionmario merged commit 0ac40c0 into wso2:master Apr 17, 2026
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants