Add Vue quickstart guide and update documentation navigation#5988
Add Vue quickstart guide and update documentation navigation#5988brionmario merged 3 commits intowso2:masterfrom
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (3)
📝 WalkthroughWalkthroughAdds 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
Suggested labels
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (4)
en/asgardeo/docs/quick-starts/vue.mden/asgardeo/mkdocs.ymlen/base.ymlen/includes/quick-starts/vue.md
7451c9b to
f015ae6
Compare
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:
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:
mkdocs.yml) to include the new Vue quickstart under the SDKs section.base.yml). [1] [2]Related PRs
Test environment
Security checks