Skip to content

fix: Modify the redirection document address#1758

Merged
hexqi merged 1 commit intoopentiny:developfrom
xuanlid:fix/docs-jump
Feb 2, 2026
Merged

fix: Modify the redirection document address#1758
hexqi merged 1 commit intoopentiny:developfrom
xuanlid:fix/docs-jump

Conversation

@xuanlid
Copy link
Contributor

@xuanlid xuanlid commented Feb 2, 2026

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

Background and solution

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

Release Notes

  • Documentation
    • Documentation links across README files have been migrated to the new docs.opentiny.design domain for improved accessibility
    • Help navigation system updated with clearer, more readable documentation paths
    • All documentation references now point to the centralized documentation portal

✏️ Tip: You can customize this high-level summary in your review settings.

@github-actions github-actions bot added the bug Something isn't working label Feb 2, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 2, 2026

Walkthrough

This pull request migrates documentation URLs across the project from the legacy opentiny.design domain to the new docs.opentiny.design subdomain. Additionally, help documentation identifiers in the help plugin are refactored from numeric IDs to semantic slug-based strings, with the base URL path restructured accordingly.

Changes

Cohort / File(s) Summary
README Documentation
README.md, README.zh-CN.md, packages/design-core/README.md
Updated four documentation hyperlinks from https://opentiny.design/tiny-engine#/help-center/course/... to https://docs.opentiny.design/tiny-engine/... URLs.
Help Plugin Files
packages/plugins/help/src/HelpIcon.vue
Updated four URL constants for help resources and course links from opentiny.design to docs.opentiny.design domain with restructured path format.
Help Composable
packages/plugins/help/src/composable/useHelp.ts
Migrated base URL from legacy help-center path to new guide path format; refactored helpState.docsUrl mappings from numeric identifiers (2, 3, 6, 7, 8, 11, 12, 13) to semantic string slugs (e.g., 'page-management', 'block-management', 'state-management-and-variable-binding').
Template Configuration
packages/engine-cli/template/designer/registry.js
Updated documentation URL reference in a code comment from old opentiny.design to docs.opentiny.design domain.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 URLs hopped from old to new,
Docs now docs.design—a clearer view!
Slugs replace numbers, semantics reign,
Help links guide us down the lane! 🌿✨

🚥 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 main change: updating documentation URLs from opentiny.design to docs.opentiny.design across multiple 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 docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

@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: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
packages/plugins/help/src/composable/useHelp.ts (1)

14-32: ⚠️ Potential issue | 🟠 Major

Document breaking change in CHANGELOG: URL structure refactored from numeric IDs to semantic slugs.

All new documentation URLs are valid and accessible. The refactoring improves readability by replacing numeric identifiers with semantic slugs, and public API signatures remain unchanged. However, this is a breaking change affecting 8+ internal consumers across plugins (script, state, page, i18n, datasource, block, stylePanel, bridge). Per project standards, this breaking change must be documented in the CHANGELOG.

@hexqi hexqi merged commit f6bab5c into opentiny:develop Feb 2, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants