docs(changelog): update changelog and runtime doc #1749
Conversation
|
Warning Rate limit exceeded@zzcr has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 40 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe recent updates introduce exciting new features, including auto-tip directives, fluent-editor components, and mobile-first templates. Several bug fixes enhance stability and usability, addressing issues in button groups, timelines, and nav-menus. Documentation improvements and new CDN options for Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
|
[e2e-test-warn] The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug". Please make sure you've read our contributing guide |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (1)
examples/sites/playground.html (1)
7-7: CDN Host Update IncompleteThe update to the
cdnHostvariable to 'https://registry.npmmirror.com' has not been consistently applied across the codebase. Multiple other CDN URLs are still present:
examples/react-site/index.htmlexamples/sites/index.htmlexamples/sites/demos/pc/app/watermark/image.vueexamples/sites/demos/pc/app/watermark/image-composition-api.vueexamples/sites/demos/pc/app/tree-menu/default-expanded-keys-highlight.vueexamples/sites/demos/pc/app/qr-code/icon.vueexamples/sites/demos/pc/app/qr-code/icon-composition-api.vueexamples/sites/demos/mobile-first/app/file-upload/multi-media-native.vueexamples/sites/demos/mobile-first/app/file-upload/multi-media.vueexamples/sites/demos/mobile-first/app/file-upload/display-only-video-audio.vueexamples/sites/demos/mobile-first/app/file-upload/audio.vueexamples/sites/demos/pc/app/nav-menu/allow-full-url-composition-api.vueexamples/sites/demos/pc/app/nav-menu/allow-full-url.vueexamples/sites/demos/pc/app/chart/webdoc/chart-heatmap.jsexamples/sites/demos/pc/app/chart/webdoc/chart-map.jsexamples/sites/demos/pc/app/chart/bmap/base.vueexamples/sites/demos/pc/app/chart/bmap/base-composition-api.vueexamples/sites/demos/pc/app/chart/amap/base-composition-api.vueexamples/sites/demos/pc/app/chart/amap/base.vuePlease manually verify and update all CDN URLs to ensure they are correctly loaded from 'https://registry.npmmirror.com'.
Analysis chain
CDN Host Update
The
cdnHostvariable has been updated to 'https://registry.npmmirror.com'. This change should be verified across the application to ensure that all resources are correctly loaded from this new CDN. Additionally, verify that this CDN provides all necessary files with acceptable latency and uptime.Also applies to: 10-10
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that all resources are loaded from the new CDN and check for latency and uptime. # Test: Search for CDN usage in HTML and JavaScript files. Expect: Only occurrences of the new CDN. rg --type html,js 'https://registry.npmmirror.com'Length of output: 82
Script:
#!/bin/bash # Description: Verify that all resources are loaded from the new CDN. # Test: Search for CDN usage in HTML files. Expect: Only occurrences of the new CDN. rg --type html 'https://registry.npmmirror.com' # Test: Search for CDN usage in JavaScript files. Expect: Only occurrences of the new CDN. rg --type js 'https://registry.npmmirror.com'Length of output: 179
Script:
#!/bin/bash # Description: Verify that no other CDN URLs are present in the codebase. # Test: Search for any other CDN URLs in HTML files. rg --type html 'https://' # Test: Search for any other CDN URLs in JavaScript files. rg --type js 'https://'Length of output: 5242
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- examples/sites/demos/pc/webdoc/changelog.md (1 hunks)
- examples/sites/demos/pc/webdoc/installation.md (2 hunks)
- examples/sites/playground.html (1 hunks)
- examples/sites/playground/App.vue (1 hunks)
Additional context used
Markdownlint
examples/sites/demos/pc/webdoc/changelog.md
15-15: null
Bare URL used(MD034, no-bare-urls)
16-16: null
Bare URL used(MD034, no-bare-urls)
17-17: null
Bare URL used(MD034, no-bare-urls)
18-18: null
Bare URL used(MD034, no-bare-urls)
19-19: null
Bare URL used(MD034, no-bare-urls)
20-20: null
Bare URL used(MD034, no-bare-urls)
24-24: null
Bare URL used(MD034, no-bare-urls)
25-25: null
Bare URL used(MD034, no-bare-urls)
26-26: null
Bare URL used(MD034, no-bare-urls)
27-27: null
Bare URL used(MD034, no-bare-urls)
28-28: null
Bare URL used(MD034, no-bare-urls)
29-29: null
Bare URL used(MD034, no-bare-urls)
30-30: null
Bare URL used(MD034, no-bare-urls)
34-34: null
Bare URL used(MD034, no-bare-urls)
35-35: null
Bare URL used(MD034, no-bare-urls)
36-36: null
Bare URL used(MD034, no-bare-urls)
37-37: null
Bare URL used(MD034, no-bare-urls)
38-38: null
Bare URL used(MD034, no-bare-urls)
42-42: null
Bare URL used(MD034, no-bare-urls)
44-44: null
Bare URL used(MD034, no-bare-urls)
Additional comments not posted (4)
examples/sites/playground.html (1)
7-7: Title Updated to Reflect BrandingThe title change to "OpenTinyVue 演练场" aligns with a branding or localization update. Ensure that this change is consistent across all related documentation and interfaces to maintain uniformity.
examples/sites/demos/pc/webdoc/installation.md (2)
83-111: New CDN Instructions for v3.17.0 and BeyondThe documentation now includes a detailed section for CDN usage starting from version 3.17.0, which introduces various runtime options. This is a significant update that should be highlighted in release notes and other relevant communications to ensure users are aware of these new options.
60-60: Updated CDN Instructions for Previous VersionsThe documentation now includes updated CDN instructions for versions up to 3.16.0. Ensure that these instructions are tested to confirm that they work as expected and that the URLs are correct and active.
Also applies to: 62-62
Verification successful
Updated CDN Instructions for Previous Versions
The CDN URLs mentioned in the documentation are active and redirect to the correct resources. Here are the final URLs after following the redirections:
- https://unpkg.com/[email protected]/dist/vue.esm-browser.js -> https://unpkg.com/[email protected]/dist/vue.esm-browser.js
- https://unpkg.com/@opentiny/[email protected]/runtime/tiny-vue.mjs -> https://unpkg.com/@opentiny/[email protected]/runtime/tiny-vue.mjs
- https://unpkg.com/@opentiny/[email protected]/runtime/tiny-vue-common.mjs -> https://unpkg.com/@opentiny/[email protected]/runtime/tiny-vue-common.mjs
- https://unpkg.com/@opentiny/[email protected]/runtime/tiny-vue-icon.mjs -> https://unpkg.com/@opentiny/[email protected]/runtime/tiny-vue-icon.mjs
- https://unpkg.com/@opentiny/[email protected]/runtime/tiny-vue-locale.mjs -> https://unpkg.com/@opentiny/[email protected]/runtime/tiny-vue-locale.mjs
- https://unpkg.com/@opentiny/vue-theme/index.css -> https://unpkg.com/@opentiny/[email protected]/index.css
The URLs are correct and active, ensuring that the documentation is accurate.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the availability and correctness of the CDN URLs mentioned for versions up to 3.16.0. # Test: Check the availability of the URLs. Expect: Successful HTTP responses. rg --type md 'https://unpkg.com'Length of output: 1678
Script:
#!/bin/bash # Description: Verify the availability and correctness of the CDN URLs mentioned for versions up to 3.16.0 by checking their HTTP responses. # List of URLs to check urls=( "https://unpkg.com/[email protected]/dist/vue.esm-browser.js" "https://unpkg.com/@opentiny/[email protected]/runtime/tiny-vue.mjs" "https://unpkg.com/@opentiny/[email protected]/runtime/tiny-vue-common.mjs" "https://unpkg.com/@opentiny/[email protected]/runtime/tiny-vue-icon.mjs" "https://unpkg.com/@opentiny/[email protected]/runtime/tiny-vue-locale.mjs" "https://unpkg.com/@opentiny/vue-theme/index.css" ) # Check each URL and print the HTTP status code for url in "${urls[@]}"; do http_status=$(curl -o /dev/null -s -w "%{http_code}\n" "$url") echo "URL: $url - HTTP Status: $http_status" doneLength of output: 2286
Script:
#!/bin/bash # Description: Verify the final destination of the CDN URLs by following the redirections. # List of URLs to check urls=( "https://unpkg.com/[email protected]/dist/vue.esm-browser.js" "https://unpkg.com/@opentiny/[email protected]/runtime/tiny-vue.mjs" "https://unpkg.com/@opentiny/[email protected]/runtime/tiny-vue-common.mjs" "https://unpkg.com/@opentiny/[email protected]/runtime/tiny-vue-icon.mjs" "https://unpkg.com/@opentiny/[email protected]/runtime/tiny-vue-locale.mjs" "https://unpkg.com/@opentiny/vue-theme/index.css" ) # Check each URL and print the final URL after following redirections for url in "${urls[@]}"; do final_url=$(curl -Ls -o /dev/null -w "%{url_effective}" "$url") echo "Original URL: $url - Final URL: $final_url" doneLength of output: 3405
examples/sites/playground/App.vue (1)
31-31: Version Array UpdatedThe version array has been updated to include '3.17' at the beginning. This change affects the
latestVersionlogic. Ensure that this update is reflected wherever the version is used in the application to prevent any inconsistencies.
PR
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit
New Features
Bug Fixes
Documentation
TinyVuevia CDN.TinyVue.Other Changes