Skip to content

fix: found issues reported by new no-unmatched-anchor rule#599

Open
JounQin wants to merge 1 commit intomasterfrom
fix/unmatched-anchors
Open

fix: found issues reported by new no-unmatched-anchor rule#599
JounQin wants to merge 1 commit intomasterfrom
fix/unmatched-anchors

Conversation

@JounQin
Copy link
Member

@JounQin JounQin commented Mar 20, 2026

Summary by CodeRabbit

  • Documentation

    • Added explicit section anchors across docs for more stable in-page linking and improved navigation.
    • Updated multiple Kubernetes prerequisites links to point to the centralized support matrix.
    • Removed the Kubernetes Version subsection from the upgrade notes.
  • Chores

    • Changed build tooling dependency reference to a fixed resolved artifact for reproducible builds.

Copilot AI review requested due to automatic review settings March 20, 2026 06:47
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 20, 2026

Walkthrough

Added explicit MDX anchor identifiers to many documentation headings, updated multiple cross-document links to point to the Kubernetes support matrix, removed the "Kubernetes Version" note from the upgrade overview, applied minor whitespace/newline fixes, and changed the @alauda/doom dependency in package.json to a direct package URL.

Changes

Cohort / File(s) Summary
Documentation Heading Anchors
docs/en/configure/backup/overview.mdx, docs/en/configure/clusters/managed/cloud-init/network/aws-eks.mdx, docs/en/configure/clusters/managed/cloud-init/network/azure-aks.mdx, docs/en/configure/clusters/managed/cloud-init/network/google-gke.mdx, docs/en/configure/clusters/managed/cloud-init/network/huawei-cce.mdx, docs/en/configure/clusters/managed/cloud-init/storage/aws-eks.mdx, docs/en/configure/clusters/managed/cloud-init/storage/azure-aks.mdx, docs/en/configure/clusters/managed/cloud-init/storage/google-gke.mdx, docs/en/configure/clusters/managed/cloud-init/storage/huawei-cce.mdx, docs/en/configure/clusters/managed/how-to/fetch-kubeconfig.mdx, docs/en/configure/clusters/on-premises.mdx, docs/en/configure/networking/functions/configure_alb.mdx, docs/en/configure/networking/functions/configure_domain.mdx, docs/en/configure/networking/functions/configure_gatewayapi_route.mdx, docs/en/configure/networking/functions/configure_subnet.mdx, docs/en/configure/networking/how_to/kube_ovn/multiple_networks.mdx, docs/en/configure/storage/how_to/configuring_pvc_dr.mdx, docs/en/developer/building_application/.../operator_app.mdx, docs/en/developer/building_application/namespace/resource_quota.mdx, docs/en/developer/building_application/namespace/security_policies.mdx, docs/en/developer/building_application/working_with_helm_charts.mdx, docs/en/developer/s2i/functions/s2i_application_management.mdx, docs/en/extend/cluster_plugin.mdx, docs/en/extend/upload_package.mdx, docs/en/networking/overview.mdx, docs/en/observability/monitor/functions/manage_dashboard.mdx, docs/en/overview/kubernetes-support-matrix.mdx, docs/en/security/users_and_roles/idp/functions/ldap_manage.mdx, docs/en/storage/storagesystem_ceph/concepts/concept.mdx, docs/en/storage/storagesystem_minio/installation.mdx, docs/en/virtualization/virtualization/installation.mdx, docs/en/virtualization/virtualization/virtual_machine/functions/virtual_management.mdx
Appended explicit {#anchor-name} identifiers to numerous section headings to provide stable intra-page and cross-page anchors.
Documentation Link Target Updates
docs/en/configure/clusters/managed/import/alibaba-ack.mdx, docs/en/configure/clusters/managed/import/aws-eks.mdx, docs/en/configure/clusters/managed/import/azure-aks.mdx, docs/en/configure/clusters/managed/import/gcp-gke.mdx, docs/en/configure/clusters/managed/import/huawei-cce.mdx, docs/en/configure/clusters/managed/import/openshift.mdx, docs/en/configure/clusters/managed/import/standard-kubernetes.mdx, docs/en/configure/clusters/managed/import/tencent-tke.mdx, docs/en/configure/clusters/managed/register.mdx, docs/en/configure/clusters/nodes/overview.mdx
Updated prerequisite/reference links to use the centralized Kubernetes support matrix (/overview/kubernetes-support-matrix.mdx#version-support-matrix) and adjusted one node prerequisite target to /install/prepare/node_preprocessing.mdx#supported_os_and_kernels.
Package Dependency Update
package.json
Replaced @alauda/doom semver range ^1.21.0 with a direct package URL https://pkg.pr.new/@alauda/doom@0f1b2c8.
Documentation Content Removal
docs/en/upgrade/overview.mdx
Removed the "Kubernetes Version" subsection under Notes (upgrade constraints text and related links).
Minor Formatting & Fixes
docs/en/configure/clusters/managed/import/openshift.mdx, docs/en/configure/clusters/managed/import/standard-kubernetes.mdx, docs/en/developer/building_application/concepts/custom_application.mdx, various others
Removed trailing double-spaces, fixed missing closing code fence and EOF newline, corrected small typos and trimmed trailing whitespace in multiple MDX files.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • chinameok
  • fanzy618

Poem

🐰
Anchors tucked in headings neat and small,
Links now hop true when you click and call.
Doom pinned down so builds won’t roam,
Whitespace tidied to make it home.
Hooray — the docs are snug and all!

🚥 Pre-merge checks | ✅ 3
✅ 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 accurately describes the primary change: fixing unmatched anchor issues reported by a new linting rule across multiple documentation files.
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
  • Commit unit tests in branch fix/unmatched-anchors
📝 Coding Plan
  • Generate coding plan for human review comments

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

Updates documentation to satisfy the new no-unmatched-anchor rule by adding explicit heading anchors and fixing/adjusting internal links; also updates the docs build tooling dependency and regenerates the lockfile.

Changes:

  • Added explicit heading IDs across many .mdx docs and fixed a malformed inline anchor (id="#VF_ID"id="VF_ID").
  • Updated several cross-page links to point at the correct file/anchor (e.g., support-matrix references, GatewayAPI route docs).
  • Updated @alauda/doom dependency (currently to a pkg.pr.new URL) which triggered a large yarn.lock refresh.

Reviewed changes

Copilot reviewed 45 out of 46 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
yarn.lock Large lockfile update; introduces pkg.pr.new resolutions for @alauda/doom* and updates many transitive deps.
package.json Switches @alauda/doom dependency from semver to a pkg.pr.new URL.
docs/en/virtualization/virtualization/virtual_machine/functions/virtual_management.mdx Adds explicit anchors for sections referenced elsewhere (#add-internal-routes, #configure-ip).
docs/en/virtualization/virtualization/network/how_to/vm_sriov.mdx Fixes invalid anchor id (#VF_ID) and keeps internal reference working.
docs/en/virtualization/virtualization/installation.mdx Adds explicit heading anchor for a referenced section.
docs/en/upgrade/overview.mdx Removes a “Kubernetes Version” note block (likely due to broken anchor reference).
docs/en/storage/storagesystem_minio/installation.mdx Adds explicit anchor to match an existing in-page link (#stro).
docs/en/storage/storagesystem_ceph/concepts/concept.mdx Adds explicit anchors for core concept headings.
docs/en/security/users_and_roles/idp/functions/ldap_manage.mdx Adds explicit anchor for “Add LDAP”.
docs/en/overview/kubernetes-support-matrix.mdx Adds explicit anchor for the matrix section.
docs/en/observability/monitor/functions/manage_dashboard.mdx Adds explicit anchor for “Import Dashboard”; renames an anchor for the “Common Functions and Variables” section.
docs/en/networking/overview.mdx Adds explicit anchor for “GatewayAPI”.
docs/en/extend/upload_package.mdx Adds explicit anchor for “Common Parameters”.
docs/en/extend/cluster_plugin.mdx Adds explicit anchor for “Installing via YAML”.
docs/en/developer/s2i/functions/s2i_application_management.mdx Adds explicit anchor for “Procedure”.
docs/en/developer/building_application/working_with_helm_charts.mdx Adds explicit anchor for “Understanding Helm”.
docs/en/developer/building_application/namespace/security_policies.mdx Adds explicit anchor for “Namespace Labels”.
docs/en/developer/building_application/namespace/resource_quota.mdx Adds explicit anchor for “Other Quotas”.
docs/en/developer/building_application/create_applications/operator_app.mdx Adds explicit anchor to a heading (heading text still has casing/spelling issue).
docs/en/configure/storage/how_to/configuring_pvc_dr.mdx Adds explicit anchors for scheduled and one-time sync sections.
docs/en/configure/networking/how_to/kube_ovn/multiple_networks.mdx Adds explicit anchor for “Deploying the Multus CNI Plugin”.
docs/en/configure/networking/functions/configure_subnet.mdx Adds explicit anchors for CLI bridge network and VLAN sections.
docs/en/configure/networking/functions/configure_gatewayapi_route.mdx Adds anchor for “Topology” and updates a link; still contains one malformed link path (.mdx/#...).
docs/en/configure/networking/functions/configure_domain.mdx Adds explicit anchor for “Creating Domain…”.
docs/en/configure/networking/functions/configure_alb.mdx Adds explicit anchor for dslx subsection.
docs/en/configure/clusters/on-premises.mdx Adds explicit anchor for “Node Settings”.
docs/en/configure/clusters/nodes/overview.mdx Updates a reference link to the correct page/anchor.
docs/en/configure/clusters/managed/register.mdx Updates prerequisite link to support matrix and normalizes trailing whitespace/line numbering.
docs/en/configure/clusters/managed/import/tencent-tke.mdx Updates prerequisite link to support matrix.
docs/en/configure/clusters/managed/import/standard-kubernetes.mdx Updates prerequisite link to support matrix, normalizes formatting, and adds an explicit anchor for a troubleshooting section.
docs/en/configure/clusters/managed/import/openshift.mdx Updates prerequisite link to support matrix and normalizes formatting.
docs/en/configure/clusters/managed/import/huawei-cce.mdx Updates prerequisite link to support matrix.
docs/en/configure/clusters/managed/import/gcp-gke.mdx Updates prerequisite link to support matrix.
docs/en/configure/clusters/managed/import/azure-aks.mdx Updates prerequisite link and adds explicit anchor to an FAQ heading.
docs/en/configure/clusters/managed/import/aws-eks.mdx Updates prerequisite link to support matrix.
docs/en/configure/clusters/managed/import/alibaba-ack.mdx Updates prerequisite link to support matrix.
docs/en/configure/clusters/managed/how-to/fetch-kubeconfig.mdx Replaces inline <span id=...> with explicit heading anchor syntax.
docs/en/configure/clusters/managed/cloud-init/storage/huawei-cce.mdx Adds explicit anchor to “Default Storage Class Description”.
docs/en/configure/clusters/managed/cloud-init/storage/google-gke.mdx Adds explicit anchors for multiple headings.
docs/en/configure/clusters/managed/cloud-init/storage/azure-aks.mdx Adds explicit anchors for multiple headings.
docs/en/configure/clusters/managed/cloud-init/storage/aws-eks.mdx Adds explicit anchor for available storage class parameter section.
docs/en/configure/clusters/managed/cloud-init/network/huawei-cce.mdx Adds explicit anchor for “Create Certificate”.
docs/en/configure/clusters/managed/cloud-init/network/google-gke.mdx Adds explicit anchor for “Create Certificate”.
docs/en/configure/clusters/managed/cloud-init/network/azure-aks.mdx Adds explicit anchors for ingress deployment and certificate creation.
docs/en/configure/clusters/managed/cloud-init/network/aws-eks.mdx Adds explicit anchors for multiple subsections.
docs/en/configure/backup/overview.mdx Adds explicit anchors for backup/restore sections.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

},
"dependencies": {
"@alauda/doom": "^1.21.0"
"@alauda/doom": "https://pkg.pr.new/@alauda/doom@0f1b2c8"
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

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

@alauda/doom is pinned to a pkg.pr.new URL. This makes installs non-reproducible and can break CI if the preview package disappears; it also bypasses normal npm integrity expectations. Prefer depending on a published semver version (e.g., bump ^1.21.0 to the released version that includes the rule) and regenerate the lockfile accordingly.

Copilot uses AI. Check for mistakes.
Copy link
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: 9

🧹 Nitpick comments (1)
docs/en/storage/storagesystem_minio/installation.mdx (1)

189-189: Anchor works but naming could be clearer.

The anchor {#stro} correctly matches the existing in-page link at line 77. However, #stro is a non-obvious abbreviation. Consider using {#storage-pool-overview} for better readability and consistency with other anchors in this PR (e.g., #version-support-matrix, #create-certificate).

♻️ Optional: Use descriptive anchor name
-### Storage Pool Overview \{`#stro`}
+### Storage Pool Overview \{`#storage-pool-overview`}

And update the reference at line 77:

-please refer to [Storage Pool Overview](`#stro`).
+please refer to [Storage Pool Overview](`#storage-pool-overview`).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/en/storage/storagesystem_minio/installation.mdx` at line 189, The anchor
on the "### Storage Pool Overview" header is named {`#stro`}, which is
non-obvious; change the anchor to {`#storage-pool-overview`} in the header and
update any in-page links that point to `#stro` (the link referencing the Storage
Pool Overview elsewhere in the document) to use `#storage-pool-overview` so the
anchor name is descriptive and consistent with other anchors like
`#version-support-matrix` and `#create-certificate`.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/en/configure/clusters/managed/import/alibaba-ack.mdx`:
- Line 16: The link in the sentence referencing the Kubernetes support matrix
uses an absolute path
"/overview/kubernetes-support-matrix.mdx#version-support-matrix"; update that
markdown link in the alibaba-ack.mdx content to a relative path (e.g.,
"../../overview/kubernetes-support-matrix.mdx#version-support-matrix") so it
follows the repo MDX linking rules and the project's "relative paths only"
guideline.

In `@docs/en/configure/clusters/managed/import/aws-eks.mdx`:
- Line 12: The link pointing to
/overview/kubernetes-support-matrix.mdx#version-support-matrix uses an absolute
path; update the link in the line containing "Version compatibility for
importing standard Kubernetes clusters" to use a relative MDX path that follows
the project's MDX guidelines (e.g., a correct relative path from this document
to overview/kubernetes-support-matrix.mdx with the same anchor) so the reference
becomes a relative cross-document link.

In `@docs/en/configure/clusters/managed/import/azure-aks.mdx`:
- Line 12: Replace the absolute MDX link
"/overview/kubernetes-support-matrix.mdx#version-support-matrix" in
docs/en/configure/clusters/managed/import/azure-aks.mdx with a
repository-relative path; update the link to use
"../../../../overview/kubernetes-support-matrix.mdx#version-support-matrix" so
it points to the same target using a relative reference (locate the link text
"Standard Kubernetes Cluster Component Version and Parameter Requirements" in
that file and change the href accordingly).

In `@docs/en/configure/clusters/managed/import/gcp-gke.mdx`:
- Line 12: Replace the absolute link
(/overview/kubernetes-support-matrix.mdx#version-support-matrix) in the sentence
about Kubernetes version requirements with a repository-relative path; from
docs/en/configure/clusters/managed/import/gcp-gke.mdx update the link target to
the relative path
../../overview/kubernetes-support-matrix.mdx#version-support-matrix so it
follows the rule to use only relative resource references.

In `@docs/en/configure/clusters/managed/import/openshift.mdx`:
- Line 12: Replace the absolute link
"/overview/kubernetes-support-matrix.mdx#version-support-matrix" in
docs/en/configure/clusters/managed/import/openshift.mdx with a repo-relative
path; update the Markdown reference in the line containing "The Kubernetes
version and parameters of the cluster must meet the [Standard Kubernetes Cluster
Requirements]" to use
"../../../../overview/kubernetes-support-matrix.mdx#version-support-matrix" so
it follows the docs/**/*.mdx rule of using relative paths.

In `@docs/en/configure/clusters/managed/import/standard-kubernetes.mdx`:
- Line 17: Replace the absolute cross-module link
"/overview/kubernetes-support-matrix.mdx#version-support-matrix" in the line
that starts "Kubernetes and related components in the cluster must meet the
[version and parameter requirements]" with a relative path so it complies with
the docs rule; update that href to
"../../../../overview/kubernetes-support-matrix.mdx#version-support-matrix"
(preserving the anchor and link text) in the file standard-kubernetes.mdx.

In `@docs/en/configure/clusters/nodes/overview.mdx`:
- Line 32: Change the absolute link in the sentence "Please refer to [Supported
Operating Systems and CPU
Models](/install/prepare/node_preprocessing.mdx#supported_os_and_kernels)." to a
relative path so MDX resource references follow the repo guideline; update the
href to the relative path that points from overview.mdx to
node_preprocessing.mdx and preserve the anchor "#supported_os_and_kernels"
(i.e., modify the link target for the text "Supported Operating Systems and CPU
Models" to use
"../../install/prepare/node_preprocessing.mdx#supported_os_and_kernels").

In
`@docs/en/virtualization/virtualization/virtual_machine/functions/virtual_management.mdx`:
- Line 70: The heading "Update NAT Network Configuration" currently uses the
anchor {`#add-internal-routes`}, which mismatches the incoming link labeled "Add
Internal Routes"; update either the anchor or the heading so they match: either
change the anchor to {`#update-nat-network-configuration`} to reflect the heading,
or rename the heading to "Add Internal Routes" to match the link label (and
update any other links referencing {`#add-internal-routes`} accordingly); ensure
the unique identifiers in the heading (the literal heading text "Update NAT
Network Configuration" and the anchor "{`#add-internal-routes`}") and any links
pointing to that anchor use the same label.

In `@package.json`:
- Line 17: The dependency entry for "@alauda/doom" points to a preview URL that
404s; replace the pkg.pr.new URL in package.json with the stable npm release
(pin to the exact version 1.21.5, e.g. "@alauda/doom": "1.21.5"), then run the
package manager to update the lockfile so all consumers (theme/index.ts,
global.d.ts, eslint.config.js, cspell.config.js) resolve the stable package
instead of the preview artifact. Ensure the change is committed along with the
updated lockfile.

---

Nitpick comments:
In `@docs/en/storage/storagesystem_minio/installation.mdx`:
- Line 189: The anchor on the "### Storage Pool Overview" header is named
{`#stro`}, which is non-obvious; change the anchor to {`#storage-pool-overview`} in
the header and update any in-page links that point to `#stro` (the link
referencing the Storage Pool Overview elsewhere in the document) to use
`#storage-pool-overview` so the anchor name is descriptive and consistent with
other anchors like `#version-support-matrix` and `#create-certificate`.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4aa644c9-58ea-4c84-8200-1fb560d1274a

📥 Commits

Reviewing files that changed from the base of the PR and between cc0dbb3 and 5e13576.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (45)
  • docs/en/configure/backup/overview.mdx
  • docs/en/configure/clusters/managed/cloud-init/network/aws-eks.mdx
  • docs/en/configure/clusters/managed/cloud-init/network/azure-aks.mdx
  • docs/en/configure/clusters/managed/cloud-init/network/google-gke.mdx
  • docs/en/configure/clusters/managed/cloud-init/network/huawei-cce.mdx
  • docs/en/configure/clusters/managed/cloud-init/storage/aws-eks.mdx
  • docs/en/configure/clusters/managed/cloud-init/storage/azure-aks.mdx
  • docs/en/configure/clusters/managed/cloud-init/storage/google-gke.mdx
  • docs/en/configure/clusters/managed/cloud-init/storage/huawei-cce.mdx
  • docs/en/configure/clusters/managed/how-to/fetch-kubeconfig.mdx
  • docs/en/configure/clusters/managed/import/alibaba-ack.mdx
  • docs/en/configure/clusters/managed/import/aws-eks.mdx
  • docs/en/configure/clusters/managed/import/azure-aks.mdx
  • docs/en/configure/clusters/managed/import/gcp-gke.mdx
  • docs/en/configure/clusters/managed/import/huawei-cce.mdx
  • docs/en/configure/clusters/managed/import/openshift.mdx
  • docs/en/configure/clusters/managed/import/standard-kubernetes.mdx
  • docs/en/configure/clusters/managed/import/tencent-tke.mdx
  • docs/en/configure/clusters/managed/register.mdx
  • docs/en/configure/clusters/nodes/overview.mdx
  • docs/en/configure/clusters/on-premises.mdx
  • docs/en/configure/networking/functions/configure_alb.mdx
  • docs/en/configure/networking/functions/configure_domain.mdx
  • docs/en/configure/networking/functions/configure_gatewayapi_route.mdx
  • docs/en/configure/networking/functions/configure_subnet.mdx
  • docs/en/configure/networking/how_to/kube_ovn/multiple_networks.mdx
  • docs/en/configure/storage/how_to/configuring_pvc_dr.mdx
  • docs/en/developer/building_application/create_applications/operator_app.mdx
  • docs/en/developer/building_application/namespace/resource_quota.mdx
  • docs/en/developer/building_application/namespace/security_policies.mdx
  • docs/en/developer/building_application/working_with_helm_charts.mdx
  • docs/en/developer/s2i/functions/s2i_application_management.mdx
  • docs/en/extend/cluster_plugin.mdx
  • docs/en/extend/upload_package.mdx
  • docs/en/networking/overview.mdx
  • docs/en/observability/monitor/functions/manage_dashboard.mdx
  • docs/en/overview/kubernetes-support-matrix.mdx
  • docs/en/security/users_and_roles/idp/functions/ldap_manage.mdx
  • docs/en/storage/storagesystem_ceph/concepts/concept.mdx
  • docs/en/storage/storagesystem_minio/installation.mdx
  • docs/en/upgrade/overview.mdx
  • docs/en/virtualization/virtualization/installation.mdx
  • docs/en/virtualization/virtualization/network/how_to/vm_sriov.mdx
  • docs/en/virtualization/virtualization/virtual_machine/functions/virtual_management.mdx
  • package.json
💤 Files with no reviewable changes (1)
  • docs/en/upgrade/overview.mdx

},
"dependencies": {
"@alauda/doom": "^1.21.0"
"@alauda/doom": "https://pkg.pr.new/@alauda/doom@0f1b2c8"
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "Dependency value in package.json:"
jq -r '.dependencies["@alauda/doom"]' package.json

echo
echo "Checking for preview URL pinning in package and lockfile:"
rg -n 'pkg\.pr\.new/@alauda/doom|pkg\.pr\.new/alauda/doom' package.json yarn.lock || true

echo
echo "Optional reachability check (may fail in restricted network environments):"
curl -I -L --max-time 10 "https://pkg.pr.new/@alauda/doom@0f1b2c8" | sed -n '1,5p' || true

Repository: alauda/acp-docs

Length of output: 1541


🏁 Script executed:

find . -name "theme" -type d | head -20

Repository: alauda/acp-docs

Length of output: 66


🏁 Script executed:

fd -t f "index.ts" | grep -i theme || true

Repository: alauda/acp-docs

Length of output: 73


🏁 Script executed:

# Search for any `@alauda/doom` version references or package documentation
rg "@alauda/doom" --type-list | head -5 && rg "@alauda/doom" -t ts -t json -t js | head -30 || true

Repository: alauda/acp-docs

Length of output: 768


🏁 Script executed:

# Check if there's a package-lock or any other dependency lock files
git ls-files | grep -E "(package-lock|pnpm-lock|yarn.lock|.npmrc|.yarnrc)" || true

Repository: alauda/acp-docs

Length of output: 80


🏁 Script executed:

# Check package.json for any other metadata or comments
cat -n package.json

Repository: alauda/acp-docs

Length of output: 910


🏁 Script executed:

# Check the yarn.lock entry for the broken dependency to see if it has version info
sed -n '23,35p' yarn.lock

Repository: alauda/acp-docs

Length of output: 657


🏁 Script executed:

# Search for any documentation or config mentioning doom versions
rg -i "doom.*version|version.*doom" -t md -t txt -t json || true

Repository: alauda/acp-docs

Length of output: 41


Update the @alauda/doom dependency to a stable release version.

The pkg.pr.new preview URL currently returns a 404 error and is unsuitable for a released package. The preview artifact is version 1.21.5, which should be pinned to a stable release in npm. Multiple files depend on this package (theme/index.ts, global.d.ts, eslint.config.js, cspell.config.js), so this broken dependency blocks all builds.

Suggested change
-    "@alauda/doom": "https://pkg.pr.new/@alauda/doom@0f1b2c8"
+    "@alauda/doom": "^1.21.5"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
"@alauda/doom": "https://pkg.pr.new/@alauda/doom@0f1b2c8"
"@alauda/doom": "^1.21.5"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@package.json` at line 17, The dependency entry for "@alauda/doom" points to a
preview URL that 404s; replace the pkg.pr.new URL in package.json with the
stable npm release (pin to the exact version 1.21.5, e.g. "@alauda/doom":
"1.21.5"), then run the package manager to update the lockfile so all consumers
(theme/index.ts, global.d.ts, eslint.config.js, cspell.config.js) resolve the
stable package instead of the preview artifact. Ensure the change is committed
along with the updated lockfile.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Mar 20, 2026

Deploying alauda-container-platform with  Cloudflare Pages  Cloudflare Pages

Latest commit: 517896c
Status: ✅  Deploy successful!
Preview URL: https://6a9cc5e1.alauda-container-platform.pages.dev
Branch Preview URL: https://fix-unmatched-anchors.alauda-container-platform.pages.dev

View logs

@JounQin JounQin force-pushed the fix/unmatched-anchors branch from 5e13576 to 517896c Compare March 20, 2026 07:04
Copy link
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: 1

🧹 Nitpick comments (1)
docs/en/developer/building_application/create_applications/operator_app.mdx (1)

11-11: Consider hyphenating compound modifier for consistency.

The term "Operator Backed" should be "Operator-Backed" when used as a compound modifier before a noun (standard English grammar). This would align with line 51 which uses "Operator-Backed Instance" and improve terminology consistency throughout the document.

📝 Suggested terminology consistency fix
-## Understanding Operator Backed Application {`#understanding-operator-backed-application`}
+## Understanding Operator-Backed Application {`#understanding-operator-backed-application`}

Note: This inconsistency appears throughout the document (lines 13, 28, 43) and could be addressed holistically in a separate documentation cleanup effort.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/en/developer/building_application/create_applications/operator_app.mdx`
at line 11, Update instances of the phrase "Operator Backed" to the hyphenated
form "Operator-Backed" when used as a compound modifier (e.g., in the heading
"Understanding Operator Backed Application" and other occurrences) to match the
existing "Operator-Backed Instance" usage; search the document for "Operator
Backed" and replace with "Operator-Backed" where it precedes a noun, keeping
non-modifier uses unchanged to preserve grammar consistency.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/en/configure/clusters/managed/register.mdx`:
- Line 12: The MDX uses an absolute link
(/overview/kubernetes-support-matrix.mdx); change it to a relative path from
register.mdx so it follows the repo rule—replace
"/overview/kubernetes-support-matrix.mdx" with
"../../../overview/kubernetes-support-matrix.mdx" in the link reference (the
line containing the Version and Parameter Requirements for Managed Clusters
link).

---

Nitpick comments:
In `@docs/en/developer/building_application/create_applications/operator_app.mdx`:
- Line 11: Update instances of the phrase "Operator Backed" to the hyphenated
form "Operator-Backed" when used as a compound modifier (e.g., in the heading
"Understanding Operator Backed Application" and other occurrences) to match the
existing "Operator-Backed Instance" usage; search the document for "Operator
Backed" and replace with "Operator-Backed" where it precedes a noun, keeping
non-modifier uses unchanged to preserve grammar consistency.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 970bb991-e73d-4752-a41b-0e9721169feb

📥 Commits

Reviewing files that changed from the base of the PR and between 5e13576 and 517896c.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (48)
  • docs/en/configure/backup/overview.mdx
  • docs/en/configure/clusters/managed/cloud-init/network/aws-eks.mdx
  • docs/en/configure/clusters/managed/cloud-init/network/azure-aks.mdx
  • docs/en/configure/clusters/managed/cloud-init/network/google-gke.mdx
  • docs/en/configure/clusters/managed/cloud-init/network/huawei-cce.mdx
  • docs/en/configure/clusters/managed/cloud-init/storage/aws-eks.mdx
  • docs/en/configure/clusters/managed/cloud-init/storage/azure-aks.mdx
  • docs/en/configure/clusters/managed/cloud-init/storage/google-gke.mdx
  • docs/en/configure/clusters/managed/cloud-init/storage/huawei-cce.mdx
  • docs/en/configure/clusters/managed/how-to/fetch-kubeconfig.mdx
  • docs/en/configure/clusters/managed/import/alibaba-ack.mdx
  • docs/en/configure/clusters/managed/import/aws-eks.mdx
  • docs/en/configure/clusters/managed/import/azure-aks.mdx
  • docs/en/configure/clusters/managed/import/gcp-gke.mdx
  • docs/en/configure/clusters/managed/import/huawei-cce.mdx
  • docs/en/configure/clusters/managed/import/openshift.mdx
  • docs/en/configure/clusters/managed/import/standard-kubernetes.mdx
  • docs/en/configure/clusters/managed/import/tencent-tke.mdx
  • docs/en/configure/clusters/managed/register.mdx
  • docs/en/configure/clusters/nodes/overview.mdx
  • docs/en/configure/clusters/on-premises.mdx
  • docs/en/configure/networking/functions/configure_alb.mdx
  • docs/en/configure/networking/functions/configure_domain.mdx
  • docs/en/configure/networking/functions/configure_gatewayapi_route.mdx
  • docs/en/configure/networking/functions/configure_subnet.mdx
  • docs/en/configure/networking/how_to/kube_ovn/multiple_networks.mdx
  • docs/en/configure/storage/how_to/configuring_pvc_dr.mdx
  • docs/en/developer/building_application/concepts/custom_application.mdx
  • docs/en/developer/building_application/create_applications/operator_app.mdx
  • docs/en/developer/building_application/namespace/resource_quota.mdx
  • docs/en/developer/building_application/namespace/security_policies.mdx
  • docs/en/developer/building_application/namespace/update_overcommit.mdx
  • docs/en/developer/building_application/working_with_helm_charts.mdx
  • docs/en/developer/s2i/functions/s2i_application_management.mdx
  • docs/en/extend/cluster_plugin.mdx
  • docs/en/extend/upload_package.mdx
  • docs/en/networking/overview.mdx
  • docs/en/observability/monitor/functions/manage_dashboard.mdx
  • docs/en/overview/kubernetes-support-matrix.mdx
  • docs/en/security/users_and_roles/idp/functions/ldap_manage.mdx
  • docs/en/storage/storagesystem_ceph/concepts/concept.mdx
  • docs/en/storage/storagesystem_minio/installation.mdx
  • docs/en/upgrade/overview.mdx
  • docs/en/virtualization/virtualization/installation.mdx
  • docs/en/virtualization/virtualization/network/functions/vm_network.mdx
  • docs/en/virtualization/virtualization/network/how_to/vm_sriov.mdx
  • docs/en/virtualization/virtualization/virtual_machine/functions/virtual_management.mdx
  • package.json
💤 Files with no reviewable changes (1)
  • docs/en/upgrade/overview.mdx
✅ Files skipped from review due to trivial changes (43)
  • docs/en/configure/clusters/managed/cloud-init/storage/huawei-cce.mdx
  • docs/en/configure/backup/overview.mdx
  • docs/en/developer/building_application/namespace/resource_quota.mdx
  • docs/en/configure/clusters/managed/cloud-init/network/google-gke.mdx
  • docs/en/developer/building_application/namespace/update_overcommit.mdx
  • docs/en/developer/s2i/functions/s2i_application_management.mdx
  • docs/en/configure/clusters/managed/import/alibaba-ack.mdx
  • docs/en/configure/clusters/managed/cloud-init/storage/aws-eks.mdx
  • docs/en/networking/overview.mdx
  • docs/en/virtualization/virtualization/network/functions/vm_network.mdx
  • docs/en/configure/clusters/managed/cloud-init/network/huawei-cce.mdx
  • docs/en/configure/clusters/managed/cloud-init/network/azure-aks.mdx
  • docs/en/configure/clusters/on-premises.mdx
  • docs/en/observability/monitor/functions/manage_dashboard.mdx
  • docs/en/extend/upload_package.mdx
  • docs/en/security/users_and_roles/idp/functions/ldap_manage.mdx
  • docs/en/configure/networking/how_to/kube_ovn/multiple_networks.mdx
  • docs/en/overview/kubernetes-support-matrix.mdx
  • docs/en/virtualization/virtualization/network/how_to/vm_sriov.mdx
  • docs/en/configure/clusters/managed/import/huawei-cce.mdx
  • docs/en/configure/clusters/managed/cloud-init/storage/azure-aks.mdx
  • docs/en/configure/clusters/managed/import/tencent-tke.mdx
  • docs/en/storage/storagesystem_ceph/concepts/concept.mdx
  • docs/en/developer/building_application/namespace/security_policies.mdx
  • docs/en/extend/cluster_plugin.mdx
  • docs/en/configure/networking/functions/configure_domain.mdx
  • docs/en/configure/clusters/managed/import/gcp-gke.mdx
  • docs/en/configure/networking/functions/configure_gatewayapi_route.mdx
  • docs/en/configure/clusters/managed/how-to/fetch-kubeconfig.mdx
  • docs/en/configure/clusters/nodes/overview.mdx
  • docs/en/configure/clusters/managed/cloud-init/storage/google-gke.mdx
  • docs/en/configure/networking/functions/configure_alb.mdx
  • docs/en/configure/clusters/managed/import/azure-aks.mdx
  • docs/en/virtualization/virtualization/virtual_machine/functions/virtual_management.mdx
  • docs/en/storage/storagesystem_minio/installation.mdx
  • docs/en/configure/networking/functions/configure_subnet.mdx
  • docs/en/developer/building_application/concepts/custom_application.mdx
  • docs/en/configure/clusters/managed/import/openshift.mdx
  • package.json
  • docs/en/configure/storage/how_to/configuring_pvc_dr.mdx
  • docs/en/configure/clusters/managed/import/aws-eks.mdx
  • docs/en/configure/clusters/managed/cloud-init/network/aws-eks.mdx
  • docs/en/virtualization/virtualization/installation.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/en/configure/clusters/managed/import/standard-kubernetes.mdx
  • docs/en/developer/building_application/working_with_helm_charts.mdx

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants