Skip to content

docs: add version dropdown (stable/dev) to master#11862

Merged
naorpeled merged 2 commits intomasterfrom
docs/version-dropdown
Dec 21, 2025
Merged

docs: add version dropdown (stable/dev) to master#11862
naorpeled merged 2 commits intomasterfrom
docs/version-dropdown

Conversation

@naorpeled
Copy link
Copy Markdown
Member

@naorpeled naorpeled commented Dec 20, 2025 •
edited
Loading

Adds a navbar "Version" dropdown to the Docusaurus docs site so users can quickly switch between:

image

Copilot AI review requested due to automatic review settings December 20, 2025 20:27
@qodo-free-for-open-source-projects
Copy link
Copy Markdown

qodo-free-for-open-source-projects bot commented Dec 20, 2025

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Navigation Behavior

The dropdown uses href for external navigation, which will cause a full page reload when switching versions. Consider if this is the intended behavior or if there should be any warning to users that they will lose their current page context when switching versions. Also verify that both URLs are accessible and properly configured.

 
{
    type: "dropdown",
    label: "Version",
    position: "right",
    items: [
        {
            label: "Stable (v0.3)",
            href: "https://typeorm.io",
        },
        {
            label: "Dev (master)",
            href: "https://dev.typeorm.io",
        },
    ],
},

@naorpeled naorpeled changed the title docs: add version dropdown (stable/dev) docs: add version dropdown (stable/dev) to master Dec 20, 2025
@qodo-free-for-open-source-projects
Copy link
Copy Markdown

qodo-free-for-open-source-projects bot commented Dec 20, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Use built-in version dropdown component

Replace the manually created version dropdown with the built-in Docusaurus
docsVersionDropdown component to improve usability and maintainability.

docs/docusaurus.config.ts [101-115]

 {
-    type: "dropdown",
-    label: "Version",
+    type: "docsVersionDropdown",
     position: "right",
-    items: [
-        {
-            label: "Stable (v0.3)",
-            href: "https://typeorm.io",
-        },
-        {
-            label: "Dev (master)",
-            href: "https://dev.typeorm.io",
-        },
-    ],
 },
  • Apply / Chat
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies a suboptimal implementation with hardcoded URLs and proposes using the idiomatic Docusaurus docsVersionDropdown component, which improves maintainability and user experience.

Medium
  • More

Copilot AI reviewed Dec 20, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds a version dropdown to the Docusaurus documentation site's navbar, enabling users to easily switch between the stable (v0.3) and development (master) versions of the TypeORM documentation.

Key Changes:

  • Added a "Version" dropdown to the navbar with links to both stable and dev documentation sites

G0maa
G0maa approved these changes Dec 21, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@G0maa G0maa left a comment

Choose a reason for hiding this comment

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

🚀

gioboa
gioboa approved these changes Dec 21, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@gioboa gioboa left a comment

Choose a reason for hiding this comment

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

👏

@qodo-free-for-open-source-projects
Copy link
Copy Markdown

qodo-free-for-open-source-projects bot commented Dec 21, 2025

PR Code Suggestions ✨

No code suggestions found for the PR.

@naorpeled naorpeled merged commit 2359039 into master Dec 21, 2025
16 checks passed
@naorpeled naorpeled deleted the docs/version-dropdown branch December 21, 2025 21:16
@alumni alumni mentioned this pull request Dec 30, 2025
Open
19 tasks
@Minishlink Minishlink mentioned this pull request Jan 12, 2026
Closed
mgohin pushed a commit to mgohin/typeorm that referenced this pull request Jan 15, 2026
@naorpeled @gioboa
docs: add version dropdown (stable/dev) to master (typeorm#11862)
65cba6c 
Co-authored-by: Giorgio Boa <35845425+gioboa@users.noreply.github.com>
kranners pushed a commit to kranners/typeorm that referenced this pull request Mar 1, 2026
@naorpeled @gioboa @kranners
docs: add version dropdown (stable/dev) to master (typeorm#11862)
5880dff 
Co-authored-by: Giorgio Boa <35845425+gioboa@users.noreply.github.com>
@pkuczynski pkuczynski added this to the 1.0 milestone Mar 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@alumni alumni alumni approved these changes

@G0maa G0maa G0maa approved these changes

@gioboa gioboa gioboa approved these changes

@mguida22 mguida22 Awaiting requested review from mguida22

Assignees

No one assigned

Labels

None yet

Milestone

1.0

Development

Successfully merging this pull request may close these issues.

6 participants

@naorpeled @alumni @G0maa @gioboa @pkuczynski