docs: fix demo-list children miss width style #2769

gimmyhehe · 2025-01-09T09:19:58Z

PR

修复多实例文档中，示例容器缺少width导致的demo宽度过大问题
修复前:

demo-list下的子元素与3.20网站对比，缺少了width样式

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)

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?

Yes
No

Other information

Summary by CodeRabbit

Documentation
- Simplified installation instructions for @opentiny/vue package
- Removed specific configuration recommendations and tips
- Cleaned up formatting in installation documentation
Style
- Updated demo container CSS to set width to 100%
- Improved layout responsiveness

coderabbitai · 2025-01-09T09:20:09Z

Walkthrough

This pull request involves simplifying documentation for the @opentiny/vue package across multiple files. The changes primarily focus on removing specific installation and configuration recommendations from markdown documentation files. Additionally, a minor CSS adjustment was made to a Vue component to improve layout responsiveness by setting the demo container width to 100%. The modifications aim to streamline installation instructions and enhance visual presentation.

Changes

File	Change Summary
`examples/sites/demos/pc/webdoc/installation-en.md`	Removed recommendations about version prefixing with tilde and `TINY_MODE` environment variable configuration
`examples/sites/demos/pc/webdoc/installation.md`	Deleted version dependency tips and `TINY_MODE` configuration guidance; removed redundant line break in runtime options table
`examples/sites/src/views/components/demo.vue`	Added `width: 100%;` to `.demo-container` class for full-width layout

Possibly related PRs

docs: 删除smb配置以及相关依赖 #2332: Removal of specific package installation recommendations
doc: 修复网站中引入组件部分示例代码错误问题 #2387: Documentation changes for component imports
refactor(theme-doc): add ThemeTools docs #2403: Theme configuration documentation enhancements
feat: add changelog and remove rich-text-editor menu #2448: Changelog introduction and menu simplification
fix(docs): fix the wrong filename #2510: Documentation configuration detail fixes

Suggested labels

documentation, bug

Suggested reviewers

zzcr

Poem

🐰 Docs trimmed with care, complexity shed light,
Configuration tips now take flight.
A demo container stretching wide,
Simplicity becomes our guide.
Code rabbit hops with glee so bright! 🌟

📜 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 4adc5f1 and 0d4c470.

📒 Files selected for processing (3)

examples/sites/demos/pc/webdoc/installation-en.md (0 hunks)
examples/sites/demos/pc/webdoc/installation.md (1 hunks)
examples/sites/src/views/components/demo.vue (1 hunks)

💤 Files with no reviewable changes (1)

examples/sites/demos/pc/webdoc/installation-en.md

🔇 Additional comments (2)

examples/sites/src/views/components/demo.vue (1)

304-304: LGTM! This fixes the demo container width issue.

Setting width: 100% ensures the demo container properly fills its parent element, preventing the excessively wide demo display issue mentioned in the PR objectives.

examples/sites/demos/pc/webdoc/installation.md (1)

85-85: LGTM! Clear documentation for the runtime option.

The addition of the tiny-vue-pc.mjs entry in the runtime table is well-documented and follows the existing format.

Finishing Touches

📝 Generate Docstrings

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?

❤️ 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.

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. (Beta)
@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.

petercat-assistant · 2025-01-09T09:20:26Z

Walkthrough

此PR修复了多实例文档中示例容器缺少宽度样式的问题，导致demo宽度过大。通过为.demo-container类添加width: 100%样式，确保子元素宽度正确。

Changes

文件	概要
examples/sites/demos/pc/webdoc/installation-en.md, examples/sites/demos/pc/webdoc/installation.md	移除了多余的`<br>`标签，调整了文档格式。
examples/sites/src/views/components/demo.vue	为`.demo-container`类添加了`width: 100%`样式。

petercat-assistant · 2025-01-09T09:20:28Z

examples/sites/src/views/components/demo.vue

@@ -301,6 +301,7 @@ export default defineComponent({
 <style lang="less" scoped>
 .demo-container {
  min-height: 200px;
+  width: 100%;


Adding width: 100% to .demo-container ensures that the demo elements have the correct width, fixing the issue of excessive width in the demo.

Issues-translate-bot · 2025-01-09T09:20:36Z

Bot detected the issue body's language is not English, translate it automatically.

Walkthrough

This PR fixes the problem of missing width styles for example containers in multi-instance documents, causing the demo width to be too large. Make sure the child elements have the correct width by adding a width: 100% style to the .demo-container class.

Changes

Documentation	Summary
examples/sites/demos/pc/webdoc/installation-en.md, examples/sites/demos/pc/webdoc/installation.md	Removed redundant `<br>` tags and adjusted the document format.
examples/sites/src/views/components/demo.vue	Added `width: 100%` style to `.demo-container` class.

github-actions · 2025-01-09T09:21:31Z

[e2e-test-warn]
The component to be tested is missing.

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

* docs: change docs content * docs: fix demo-list children miss width style

gimmyhehe added 2 commits January 9, 2025 17:11

docs: change docs content

91fa5ec

docs: fix demo-list children miss width style

0d4c470

github-actions bot added the documentation 对文档的改进或补充 label Jan 9, 2025

petercat-assistant bot reviewed Jan 9, 2025

View reviewed changes

zzcr approved these changes Jan 10, 2025

View reviewed changes

zzcr merged commit 8373a4d into release-3.21.0 Jan 10, 2025
15 of 26 checks passed

zzcr pushed a commit that referenced this pull request Jan 13, 2025

docs: fix demo-list children miss width style (#2769)

d18c831

* docs: change docs content * docs: fix demo-list children miss width style

kagol pushed a commit that referenced this pull request Jan 13, 2025

docs: fix demo-list children miss width style (#2769)

9d63b9f

* docs: change docs content * docs: fix demo-list children miss width style

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: fix demo-list children miss width style #2769

docs: fix demo-list children miss width style #2769

gimmyhehe commented Jan 9, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 9, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

petercat-assistant bot commented Jan 9, 2025

petercat-assistant bot Jan 9, 2025

Issues-translate-bot commented Jan 9, 2025

github-actions bot commented Jan 9, 2025

docs: fix demo-list children miss width style #2769

docs: fix demo-list children miss width style #2769

Conversation

gimmyhehe commented Jan 9, 2025 • edited by coderabbitai bot Loading

PR

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

Summary by CodeRabbit

coderabbitai bot commented Jan 9, 2025 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Finishing Touches

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

petercat-assistant bot commented Jan 9, 2025

Walkthrough

Changes

petercat-assistant bot Jan 9, 2025

Choose a reason for hiding this comment

Issues-translate-bot commented Jan 9, 2025

Walkthrough

Changes

github-actions bot commented Jan 9, 2025

gimmyhehe commented Jan 9, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 9, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)