tiny-engine icon indicating copy to clipboard operation
tiny-engine copied to clipboard
verified publisher icon opentiny

feat: replace docs img

Open xuanlid opened this issue 8 months ago • 1 comments

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

  • Documentation
    • Corrected a typographical error to accurately reflect the intended state value in the guides.
    • Updated several image references and file paths to ensure visuals display properly in all sections.
    • Enhanced the overall clarity and presentation of the documentation for a better user experience.

xuanlid avatar Apr 01 '25 06:04 xuanlid

Walkthrough

The documentation has been updated to correct image paths and fix a typographical error related to a boolean value. Several image references were changed to point to the correct directories and file formats, ensuring accurate and functional documentation visuals. No changes were made to any exported or public code entities.

Changes

File(s) Change Summary
docs/advanced-features/conditional-rendering.md Corrected typo "ture" to "true" in text and image filename for isLogin state.
docs/advanced-features/data-source-and-collection-mock-data.md Updated image path from not-found/dataSource6.png to ./imgs/dataSource6.png.
docs/api/frontend-api/settings-panel-api.md Changed image path from ./imgs/bindEventApi.png to ../imgs/bindEventApi.png.
docs/basic-features/frontend-application-flow.md Updated image path from not-found/添加组件.png to ./imgs/添加组件.gif.
docs/basic-features/inline-style-variable-binding.md Corrected image path from not-found/绑定变量.png to ./imgs/绑定变量.png.

Poem

🐰
Hopping through docs, I fix each trail,
Paths to images, now will not fail.
A typo in "true"—now clear and bright,
GIFs and PNGs are referenced right.
With every hop, the docs improve—
A rabbit's work, in every move!

[!TIP]

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 174c2929db9f714a8c28bd1c04a58ad1ef7e093f and fb5d85405618636a4773ff167d980e2f1be0563d.

⛔ Files ignored due to path filters (133)
  • docs/advanced-features/imgs/ScreenShot_20241029195609.png is excluded by !**/*.png
  • docs/advanced-features/imgs/add-Function.png is excluded by !**/*.png
  • docs/advanced-features/imgs/addVar-17.png is excluded by !**/*.png
  • docs/advanced-features/imgs/addVar-19.png is excluded by !**/*.png
  • docs/advanced-features/imgs/addvar-15.png is excluded by !**/*.png
  • docs/advanced-features/imgs/bindEvent.gif is excluded by !**/*.gif
  • docs/advanced-features/imgs/bindVariable-16.png is excluded by !**/*.png
  • docs/advanced-features/imgs/bindVariable-18.png is excluded by !**/*.png
  • docs/advanced-features/imgs/blockBaseSetting.png is excluded by !**/*.png
  • docs/advanced-features/imgs/blockExposeAttr.gif is excluded by !**/*.gif
  • docs/advanced-features/imgs/conditionRender.gif is excluded by !**/*.gif
  • docs/advanced-features/imgs/createBlockFromPage.gif is excluded by !**/*.gif
  • docs/advanced-features/imgs/createEmptyBlock.png is excluded by !**/*.png
  • docs/advanced-features/imgs/data-source-1.png is excluded by !**/*.png
  • docs/advanced-features/imgs/data-source-2.png is excluded by !**/*.png
  • docs/advanced-features/imgs/data-source-3.png is excluded by !**/*.png
  • docs/advanced-features/imgs/data-source-4.png is excluded by !**/*.png
  • docs/advanced-features/imgs/data-source-load-1.png is excluded by !**/*.png
  • docs/advanced-features/imgs/data-source-load-2.png is excluded by !**/*.png
  • docs/advanced-features/imgs/data-source-load-3.png is excluded by !**/*.png
  • docs/advanced-features/imgs/dataSource1.png is excluded by !**/*.png
  • docs/advanced-features/imgs/dataSource2.png is excluded by !**/*.png
  • docs/advanced-features/imgs/dataSource3.png is excluded by !**/*.png
  • docs/advanced-features/imgs/dataSource4.png is excluded by !**/*.png
  • docs/advanced-features/imgs/dataSource5.png is excluded by !**/*.png
  • docs/advanced-features/imgs/dataSource6.png is excluded by !**/*.png
  • docs/advanced-features/imgs/dataSource7.png is excluded by !**/*.png
  • docs/advanced-features/imgs/defineslot.gif is excluded by !**/*.gif
  • docs/advanced-features/imgs/icon-code.png is excluded by !**/*.png
  • docs/advanced-features/imgs/openAiWindow.png is excluded by !**/*.png
  • docs/advanced-features/imgs/pageJs.png is excluded by !**/*.png
  • docs/advanced-features/imgs/pageJsContent.png is excluded by !**/*.png
  • docs/advanced-features/imgs/pageJsJsxFunc.png is excluded by !**/*.png
  • docs/advanced-features/imgs/pageJsMethod.png is excluded by !**/*.png
  • docs/advanced-features/imgs/parseJxBindingJsxFunc.png is excluded by !**/*.png
  • docs/advanced-features/imgs/parseJxBindingJsxFuncResult.png is excluded by !**/*.png
  • docs/advanced-features/imgs/state-isLogin为false时.png is excluded by !**/*.png
  • docs/advanced-features/imgs/state-isLogin为true时.png is excluded by !**/*.png
  • docs/advanced-features/imgs/state-isLogin为ture时.png is excluded by !**/*.png
  • docs/advanced-features/imgs/use-npm.png is excluded by !**/*.png
  • docs/advanced-features/imgs/viewRender.png is excluded by !**/*.png
  • docs/api/imgs/bindEventApi.png is excluded by !**/*.png
  • docs/basic-features/imgs/addComponent-13.png is excluded by !**/*.png
  • docs/basic-features/imgs/addFolder.png is excluded by !**/*.png
  • docs/basic-features/imgs/addPage.png is excluded by !**/*.png
  • docs/basic-features/imgs/addVar.png is excluded by !**/*.png
  • docs/basic-features/imgs/addWords.png is excluded by !**/*.png
  • docs/basic-features/imgs/bindVariable-25.png is excluded by !**/*.png
  • docs/basic-features/imgs/canvasoverview.png is excluded by !**/*.png
  • docs/basic-features/imgs/choseClickCompontes.png is excluded by !**/*.png
  • docs/basic-features/imgs/choseComponent.png is excluded by !**/*.png
  • docs/basic-features/imgs/choseComponentID.png is excluded by !**/*.png
  • docs/basic-features/imgs/choseFile.png is excluded by !**/*.png
  • docs/basic-features/imgs/clickNode.png is excluded by !**/*.png
  • docs/basic-features/imgs/componentDown.png is excluded by !**/*.png
  • docs/basic-features/imgs/componentUp.png is excluded by !**/*.png
  • docs/basic-features/imgs/copyComponent.png is excluded by !**/*.png
  • docs/basic-features/imgs/copyKeyValue.png is excluded by !**/*.png
  • docs/basic-features/imgs/createFolder.png is excluded by !**/*.png
  • docs/basic-features/imgs/createPage.png is excluded by !**/*.png
  • docs/basic-features/imgs/delBatchWord.png is excluded by !**/*.png
  • docs/basic-features/imgs/delWord.png is excluded by !**/*.png
  • docs/basic-features/imgs/deleteClassNameNew.gif is excluded by !**/*.gif
  • docs/basic-features/imgs/dragComponent.gif is excluded by !**/*.gif
  • docs/basic-features/imgs/editClassNameNew.gif is excluded by !**/*.gif
  • docs/basic-features/imgs/editClassNameStatic.png is excluded by !**/*.png
  • docs/basic-features/imgs/editGlobalStyleNew.gif is excluded by !**/*.gif
  • docs/basic-features/imgs/editWord.png is excluded by !**/*.png
  • docs/basic-features/imgs/eventOverview.png is excluded by !**/*.png
  • docs/basic-features/imgs/icon-add.png is excluded by !**/*.png
  • docs/basic-features/imgs/icon-code.png is excluded by !**/*.png
  • docs/basic-features/imgs/icon-copy.png is excluded by !**/*.png
  • docs/basic-features/imgs/icon-del.png is excluded by !**/*.png
  • docs/basic-features/imgs/icon-edit.png is excluded by !**/*.png
  • docs/basic-features/imgs/icon-i18n.png is excluded by !**/*.png
  • docs/basic-features/imgs/icon-page.png is excluded by !**/*.png
  • docs/basic-features/imgs/icon-tree.png is excluded by !**/*.png
  • docs/basic-features/imgs/inlineSettingResultNew.png is excluded by !**/*.png
  • docs/basic-features/imgs/inlineStyleBindVar.gif is excluded by !**/*.gif
  • docs/basic-features/imgs/inlineStyleSettingNew.gif is excluded by !**/*.gif
  • docs/basic-features/imgs/inserPosition.png is excluded by !**/*.png
  • docs/basic-features/imgs/insertComponent.gif is excluded by !**/*.gif
  • docs/basic-features/imgs/lifecycle.gif is excluded by !**/*.gif
  • docs/basic-features/imgs/modifyStyle.png is excluded by !**/*.png
  • docs/basic-features/imgs/modifyVar.png is excluded by !**/*.png
  • docs/basic-features/imgs/modifyedStyle.png is excluded by !**/*.png
  • docs/basic-features/imgs/pageManaIndex.png is excluded by !**/*.png
  • docs/basic-features/imgs/pagedelOrCopy.png is excluded by !**/*.png
  • docs/basic-features/imgs/pluginoverview.png is excluded by !**/*.png
  • docs/basic-features/imgs/preview-btn.png is excluded by !**/*.png
  • docs/basic-features/imgs/preview-pre.png is excluded by !**/*.png
  • docs/basic-features/imgs/preview.png is excluded by !**/*.png
  • docs/basic-features/imgs/selectClassNameNew.gif is excluded by !**/*.gif
  • docs/basic-features/imgs/selectParentID.png is excluded by !**/*.png
  • docs/basic-features/imgs/setClassNameNew.gif is excluded by !**/*.gif
  • docs/basic-features/imgs/setClassNameStatic.png is excluded by !**/*.png
  • docs/basic-features/imgs/setCompoentAttr.png is excluded by !**/*.png
  • docs/basic-features/imgs/setCompoentBaseAttr.png is excluded by !**/*.png
  • docs/basic-features/imgs/setCompoentStyle.png is excluded by !**/*.png
  • docs/basic-features/imgs/setIndex-20.png is excluded by !**/*.png
  • docs/basic-features/imgs/setStyleHoverNew.gif is excluded by !**/*.gif
  • docs/basic-features/imgs/settingPanelOverview.png is excluded by !**/*.png
  • docs/basic-features/imgs/state1.gif is excluded by !**/*.gif
  • docs/basic-features/imgs/state2.gif is excluded by !**/*.gif
  • docs/basic-features/imgs/state3.png is excluded by !**/*.png
  • docs/basic-features/imgs/stylePanelOverview.png is excluded by !**/*.png
  • docs/basic-features/imgs/styleSettingNew.gif is excluded by !**/*.gif
  • docs/basic-features/imgs/styleSettingResult1.png is excluded by !**/*.png
  • docs/basic-features/imgs/styleSettingResult2.png is excluded by !**/*.png
  • docs/basic-features/imgs/styleSettingStatic.png is excluded by !**/*.png
  • docs/basic-features/imgs/toolbaroverview.png is excluded by !**/*.png
  • docs/basic-features/imgs/treeselectOverview.png is excluded by !**/*.png
  • docs/basic-features/imgs/添加组件.gif is excluded by !**/*.gif
  • docs/basic-features/imgs/绑定变量.png is excluded by !**/*.png
  • docs/ecosystem-center/imgs/ecology1.png is excluded by !**/*.png
  • docs/extension-capabilities-tutorial/imgs/plugin1.png is excluded by !**/*.png
  • docs/extension-capabilities-tutorial/imgs/plugin2.png is excluded by !**/*.png
  • docs/extension-capabilities-tutorial/imgs/plugin3.png is excluded by !**/*.png
  • docs/extension-capabilities-tutorial/imgs/plugin4.png is excluded by !**/*.png
  • docs/extension-capabilities-tutorial/imgs/plugin5.png is excluded by !**/*.png
  • docs/extension-capabilities-tutorial/imgs/plugin6.png is excluded by !**/*.png
  • docs/extension-capabilities-tutorial/imgs/plugin7.png is excluded by !**/*.png
  • docs/getting-started/imgs/addComponent.png is excluded by !**/*.png
  • docs/getting-started/imgs/addState.png is excluded by !**/*.png
  • docs/getting-started/imgs/bangEnv.png is excluded by !**/*.png
  • docs/getting-started/imgs/imgswitch.png is excluded by !**/*.png
  • docs/getting-started/imgs/page1.png is excluded by !**/*.png
  • docs/getting-started/imgs/preImgChange.png is excluded by !**/*.png
  • docs/getting-started/imgs/setImgSrc.png is excluded by !**/*.png
  • docs/getting-started/imgs/setImgSta.png is excluded by !**/*.png
  • docs/getting-started/imgs/setImgSty.png is excluded by !**/*.png
  • docs/getting-started/imgs/showImg.png is excluded by !**/*.png
  • docs/solutions/imgs/snippets.png is excluded by !**/*.png
📒 Files selected for processing (5)
  • docs/advanced-features/conditional-rendering.md (1 hunks)
  • docs/advanced-features/data-source-and-collection-mock-data.md (1 hunks)
  • docs/api/frontend-api/settings-panel-api.md (1 hunks)
  • docs/basic-features/frontend-application-flow.md (1 hunks)
  • docs/basic-features/inline-style-variable-binding.md (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • docs/api/frontend-api/settings-panel-api.md
  • docs/advanced-features/data-source-and-collection-mock-data.md
🚧 Files skipped from review as they are similar to previous changes (3)
  • docs/basic-features/inline-style-variable-binding.md
  • docs/basic-features/frontend-application-flow.md
  • docs/advanced-features/conditional-rendering.md
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check

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

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Apr 01 '25 06:04 coderabbitai[bot]