Skip to content

fix(theme): remove oldTheme's DOCS #2417

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
Oct 28, 2024

Conversation

shenjunjian
Copy link
Collaborator

@shenjunjian shenjunjian commented Oct 28, 2024

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)

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:

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
    • Clarified theme configuration details for the @opentiny/vue library.
    • Updated warnings to specify support for versions after @opentiny/vue@3.19.0.
    • Enhanced explanations on global and component-level CSS variables.
    • Expanded guidance on using the TinyThemeTool class for theme customization.
    • Updated micro-frontend section for style mounting to ShadowRoot.
    • Removed references to outdated theme configurations and practices.
    • Provided a comprehensive guide on theme switching methods.

Copy link

coderabbitai bot commented Oct 28, 2024

Walkthrough

The changes primarily focus on updating the documentation for theme configuration related to the @opentiny/vue library. Key modifications include clarifying the support for theme customization, refining explanations of CSS variables, and enhancing the section on custom themes with detailed usage instructions. References to outdated themes have been removed, and the document now includes guidance on style isolation in micro-frontend scenarios and theme switching methods.

Changes

File Path Change Summary
examples/sites/demos/pc/webdoc/theme.md - Updated theme customization warning for @opentiny/vue to specify version support.
- Commented out old theme style references.
- Refined CSS variables section, changing "样式" to "CSS 变量".
- Updated path for global CSS variables source code.
- Expanded explanation on using TinyThemeTool for customization.
- Clarified mounting styles to ShadowRoot in micro-frontend scenarios.
- Removed section on old theme configuration.
- Provided comprehensive guide on theme switching methods.

Possibly related PRs

Suggested labels

documentation

Suggested reviewers

  • zzcr

Poem

🐇 In the garden of themes, we now clearly see,
A guide for the rabbits, as bright as can be.
With CSS variables shining so bright,
Old paths are forgotten, we leap into light.
Custom themes now dance, with tools to explore,
In the world of @opentiny/vue, there’s so much in store! 🌼


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

@github-actions github-actions bot added the bug Something isn't working label Oct 28, 2024
Copy link

[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

Copy link

@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

🧹 Outside diff range and nitpick comments (2)
examples/sites/demos/pc/webdoc/theme.md (2)

Line range hint 106-120: Remove commented-out OLD theme configuration section.

Instead of commenting out the old theme configuration section, it should be completely removed since:

  1. The PR's objective is to remove oldTheme's documentation
  2. Commented-out code can lead to confusion and maintenance issues

Line range hint 1-300: Consider restructuring the legacy version documentation.

While the documentation effectively separates new and legacy theme configurations, consider:

  1. Moving the legacy version documentation (3.18.0 and earlier) to a separate archived documentation file
  2. Adding a prominent notice at the top of this document linking to the archived documentation
  3. This would help maintain a cleaner, more focused documentation for the current version while still preserving historical information

This restructuring would:

  • Reduce confusion between current and legacy implementations
  • Improve maintainability of the documentation
  • Provide a clearer upgrade path for users
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e7aa4a7 and b6ede4a.

📒 Files selected for processing (1)
  • examples/sites/demos/pc/webdoc/theme.md (4 hunks)
🔇 Additional comments (3)
examples/sites/demos/pc/webdoc/theme.md (3)

7-9: LGTM! Clear version transition messaging.

The changes appropriately communicate the transition to the new Opentiny Design style while removing references to the old theme configuration, which aligns with the PR objectives.


14-14: LGTM! Clear documentation paths.

The updated paths and terminology improvements enhance clarity by specifically referring to CSS variables.

Also applies to: 16-16


132-132: LGTM! Appropriate version reference.

The link correctly points to v3.18.0, providing a clear reference point for users of older versions.

@shenjunjian shenjunjian added documentation 对文档的改进或补充 and removed bug Something isn't working labels Oct 28, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation 对文档的改进或补充
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants