chore: change legacy docs usage #189

JounQin · 2025-10-13T14:40:23Z

close IDP-1319

Summary by CodeRabbit

Bug Fixes
- Updated legacy documentation navigation: version labels no longer include a leading “v”.
- Legacy docs links now use the new URL format with a language parameter for improved consistency.
- Legacy links now target only the .cn documentation domain (with localhost in non-production).
Chores
- Added a changeset for a patch release documenting legacy docs usage adjustments; no code or public API changes.

close IDP-1319

changeset-bot · 2025-10-13T14:40:26Z

🦋 Changeset detected

Latest commit: 91e9724

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@alauda/doom	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copilot

Pull Request Overview

This PR updates legacy documentation URLs and version handling in the VersionsNav component. It standardizes version format by removing the "v" prefix from the LEGACY_VERSIONS array and updates the legacy documentation domain configuration.

Removed "v" prefix from legacy version strings for consistency
Changed legacy documentation URL structure to point to the new cloud.alauda.cn domain
Removed docs.alauda.io from the allowed legacy domains list

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

packages/doom/src/global/VersionsNav/index.tsx

Signed-off-by: JounQin <admin@1stg.me>

coderabbitai · 2025-10-13T14:41:01Z

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Adds a changeset documenting a patch release for @alauda/doom. Updates VersionsNav to remove leading "v" from legacy versions, adjust legacy navigation URLs with version and language parameters, and restrict allowed legacy domains to docs.alauda.cn (plus localhost in non-production).

Changes

Cohort / File(s)	Summary of Changes
Release meta `\.changeset/eighty-candles-wave.md`	Adds a changeset for a patch release; notes legacy docs usage changes. No code/API changes.
Legacy versions navigation `packages/doom/src/global/VersionsNav/index.tsx`	Removes "v" prefix from LEGACY_VERSIONS; updates LEGACY_NAV_ITEMS URL construction to include version parameter formatting and language flag; narrows ALLOWED_LEGACY_DOMAINS to `docs.alauda.cn` (keeps localhost in non-prod). No exported API signature changes.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant UI as VersionsNav (UI)
  participant Nav as Link Builder
  participant Guard as Domain Allowlist
  participant Ext as Legacy Docs Site

  User->>UI: Select legacy version
  UI->>Nav: Request URL for selected version + lang
  Nav->>Guard: Validate target domain (docs.alauda.cn / localhost in non-prod)
  Guard-->>Nav: Allowed / Blocked
  alt Allowed
    Nav-->>UI: Return formatted URL (?version=...&lang=...)
    UI->>Ext: Navigate to legacy docs
    Ext-->>User: Render legacy docs
  else Blocked
    UI-->>User: Navigation prevented
  end

  note over Nav,Guard: Version strings no longer include leading "v"

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

chore(deps): bump rspress to v2.0.0-beta.29 #166 — Also modifies VersionsNav to change how version/navigation values are sourced and constructed.
feat: bump rspress to v2.0.0-beta.20 #119 — Adjusts VersionsNav base URL handling and versioned navigation behavior in the same module.

Suggested labels

internal

Poem

Hop hop, release so neat,
Trimmed the v from every treat.
One warren gate for docs we know,
CN burrow is where we go.
Links now speak in tidy tongues—
Patchy carrots, fewer wrongs. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title succinctly reflects the primary changeset by indicating an update to legacy documentation usage and follows the conventional “chore” prefix, making it clear and concise without extraneous details.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch chore/legacy_docs

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.}

pkg-pr-new · 2025-10-13T14:42:24Z

Open in StackBlitz

yarn add https://pkg.pr.new/@alauda/doom@189.tgz

yarn add https://pkg.pr.new/@alauda/doom-export@189.tgz

commit: 91e9724

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2373559 and 91e9724.

📒 Files selected for processing (2)

.changeset/eighty-candles-wave.md (1 hunks)
packages/doom/src/global/VersionsNav/index.tsx (1 hunks)

🧰 Additional context used

📓 Path-based instructions (5)

**/*.{ts,tsx,js,jsx,md,yml,yaml,json}

📄 CodeRabbit inference engine (AGENTS.md)

Format code using the repository’s Prettier configuration (yarn format)

Files:

packages/doom/src/global/VersionsNav/index.tsx

**/*.{ts,tsx}

📄 CodeRabbit inference engine (AGENTS.md)

**/*.{ts,tsx}: Code must adhere to TypeScript strict-mode rules (no implicit any, strict null checks, etc.)
Maintain strong type coverage; validate with yarn typecov

Files:

packages/doom/src/global/VersionsNav/index.tsx

**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (AGENTS.md)

Follow ESLint project-specific rules; avoid disabling rules without justification

Files:

packages/doom/src/global/VersionsNav/index.tsx

packages/**

📄 CodeRabbit inference engine (AGENTS.md)

Organize code as a Yarn workspaces monorepo; place package code under packages/

Files:

packages/doom/src/global/VersionsNav/index.tsx

packages/doom/**

📄 CodeRabbit inference engine (AGENTS.md)

Place the main documentation tool and CLI in packages/doom/

Files:

packages/doom/src/global/VersionsNav/index.tsx

🧠 Learnings (1)

📚 Learning: 2025-09-24T04:08:32.103Z

Learnt from: CR
PR: alauda/doom#0
File: AGENTS.md:0-0
Timestamp: 2025-09-24T04:08:32.103Z
Learning: Applies to packages/doom/** : Place the main documentation tool and CLI in packages/doom/

Applied to files:

.changeset/eighty-candles-wave.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)

GitHub Check: Build and Lint with Node.js 22 on ubuntu-latest
GitHub Check: Build and Lint with Node.js 18 on ubuntu-latest
GitHub Check: Build and Lint with Node.js 24 on ubuntu-latest
GitHub Check: Build and Lint with Node.js 20 on ubuntu-latest
GitHub Check: Build and Lint with Node.js 22 on ubuntu-latest
GitHub Check: Build and Lint with Node.js 20 on ubuntu-latest
GitHub Check: Build and Lint with Node.js 24 on ubuntu-latest
GitHub Check: Build and Lint with Node.js 18 on ubuntu-latest

🔇 Additional comments (2)

.changeset/eighty-candles-wave.md (1)

1-5: LGTM! Changeset correctly formatted.

The changeset follows the standard format and appropriately categorizes this as a patch-level change for the @alauda/doom package.

packages/doom/src/global/VersionsNav/index.tsx (1)

29-29: Good data normalization pattern.

Storing version numbers without the "v" prefix in the LEGACY_VERSIONS array and adding it programmatically in the URL template (line 33) is a clean separation of data and presentation. This approach makes the version data more reusable and the formatting explicit.

Regarding the past review comment: The current implementation is correct. The backend URL expects version=v3.18.1 format, so adding the "v" prefix in the template literal is necessary and intentional.

Also applies to: 33-33

packages/doom/src/global/VersionsNav/index.tsx

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2373559 and 91e9724.

📒 Files selected for processing (2)

.changeset/eighty-candles-wave.md (1 hunks)
packages/doom/src/global/VersionsNav/index.tsx (1 hunks)

🧰 Additional context used

📓 Path-based instructions (5)

**/*.{ts,tsx,js,jsx,md,yml,yaml,json}

📄 CodeRabbit inference engine (AGENTS.md)

Format code using the repository’s Prettier configuration (yarn format)

Files:

packages/doom/src/global/VersionsNav/index.tsx

**/*.{ts,tsx}

📄 CodeRabbit inference engine (AGENTS.md)

**/*.{ts,tsx}: Code must adhere to TypeScript strict-mode rules (no implicit any, strict null checks, etc.)
Maintain strong type coverage; validate with yarn typecov

Files:

packages/doom/src/global/VersionsNav/index.tsx

**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (AGENTS.md)

Follow ESLint project-specific rules; avoid disabling rules without justification

Files:

packages/doom/src/global/VersionsNav/index.tsx

packages/**

📄 CodeRabbit inference engine (AGENTS.md)

Organize code as a Yarn workspaces monorepo; place package code under packages/

Files:

packages/doom/src/global/VersionsNav/index.tsx

packages/doom/**

📄 CodeRabbit inference engine (AGENTS.md)

Place the main documentation tool and CLI in packages/doom/

Files:

packages/doom/src/global/VersionsNav/index.tsx

🧠 Learnings (1)

📚 Learning: 2025-09-24T04:08:32.103Z

Learnt from: CR
PR: alauda/doom#0
File: AGENTS.md:0-0
Timestamp: 2025-09-24T04:08:32.103Z
Learning: Applies to packages/doom/** : Place the main documentation tool and CLI in packages/doom/

Applied to files:

.changeset/eighty-candles-wave.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)

GitHub Check: Build and Lint with Node.js 22 on ubuntu-latest
GitHub Check: Build and Lint with Node.js 18 on ubuntu-latest
GitHub Check: Build and Lint with Node.js 24 on ubuntu-latest
GitHub Check: Build and Lint with Node.js 20 on ubuntu-latest
GitHub Check: Build and Lint with Node.js 20 on ubuntu-latest
GitHub Check: Build and Lint with Node.js 18 on ubuntu-latest

🔇 Additional comments (2)

.changeset/eighty-candles-wave.md (1)

1-5: LGTM!

The changeset correctly documents a patch release for the legacy docs configuration changes.

packages/doom/src/global/VersionsNav/index.tsx (1)

29-34: LGTM! Clean version handling.

The refactor to store versions without the "v" prefix in the array (line 29) and add it back in the URL template (line 33 via v${v}) is a good practice—it separates data storage from presentation formatting. The previous comment about inconsistency is no longer applicable.

packages/doom/src/global/VersionsNav/index.tsx

chore: change legacy docs usage

181c0bb

close IDP-1319

Copilot AI review requested due to automatic review settings October 13, 2025 14:40

Copilot AI reviewed Oct 13, 2025

View reviewed changes

packages/doom/src/global/VersionsNav/index.tsx Show resolved Hide resolved

Create eighty-candles-wave.md

91e9724

Signed-off-by: JounQin <admin@1stg.me>

coderabbitai bot reviewed Oct 13, 2025

View reviewed changes

packages/doom/src/global/VersionsNav/index.tsx Show resolved Hide resolved

coderabbitai bot reviewed Oct 13, 2025

View reviewed changes

packages/doom/src/global/VersionsNav/index.tsx Show resolved Hide resolved

JounQin merged commit d29c615 into main Oct 13, 2025
16 of 17 checks passed

JounQin deleted the chore/legacy_docs branch October 13, 2025 14:48

github-actions bot mentioned this pull request Oct 13, 2025

chore: release @alauda/doom #188

Merged

github-actions bot pushed a commit that referenced this pull request Oct 13, 2025

chore: change legacy docs usage (#189)

41eaacb

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: change legacy docs usage #189

chore: change legacy docs usage #189

Uh oh!

JounQin commented Oct 13, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Oct 13, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

coderabbitai bot commented Oct 13, 2025 •

edited

Loading

Other AI code review bot(s) detected

Uh oh!

pkg-pr-new bot commented Oct 13, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

chore: change legacy docs usage #189

chore: change legacy docs usage #189

Uh oh!

Conversation

JounQin commented Oct 13, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

coderabbitai bot commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Other AI code review bot(s) detected

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested labels

Poem

Pre-merge checks and finishing touches

Uh oh!

pkg-pr-new bot commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

JounQin commented Oct 13, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Oct 13, 2025 •

edited

Loading

coderabbitai bot commented Oct 13, 2025 •

edited

Loading

pkg-pr-new bot commented Oct 13, 2025 •

edited

Loading