Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

docs: modify fluent-editor to tiny-editor #213

Merged
merged 1 commit into from
Jan 17, 2025

Conversation

kagol
Copy link
Member

@kagol kagol commented Jan 17, 2025

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
    • Updated repository URLs across multiple documentation files from fluent-editor to tiny-editor
    • Modified contributor links, issue reporting links, and project references to reflect new repository name
    • Updated package configuration and documentation metadata
    • Enhanced description in documentation configuration to include "tiny-editor"

@kagol kagol added the documentation Improvements or additions to documentation label Jan 17, 2025
Copy link

coderabbitai bot commented Jan 17, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request involves a comprehensive renaming of the project from "fluent-editor" to "tiny-editor" across multiple documentation and configuration files. The changes primarily focus on updating GitHub repository URLs, contributor links, and configuration references to reflect the new project name. This update ensures consistency in documentation and helps guide contributors and users to the correct project resources.

Changes

File Change Summary
.github/ISSUE_TEMPLATE/config.yml Updated discussion URL from fluent-editor to tiny-editor
CONTRIBUTING.md & CONTRIBUTING.zh-CN.md Replaced all repository URLs from fluent-editor to tiny-editor
README.md & README.zh-CN.md Updated contributor commit history links
package.json Modified bug report URL
packages/docs/fluent-editor/.vitepress/config.ts Updated description, base URL, and GitHub social link
packages/docs/fluent-editor/index.md Updated GitHub repository link
packages/fluent-editor/package.json Updated bug report URL

Possibly related PRs

  • docs(projects): optimize imitate yuque #218: The changes in this PR involve updates to the package.json file, specifically related to dependencies for the @opentiny/fluent-editor, which is relevant as the main PR also involves modifications to the fluent-editor repository links and configurations.
  • docs(projects): optimize yuque project #219: This PR includes modifications to the packages/fluent-editor/src/config/editor.utils.ts file, which is part of the fluent-editor package. The main PR's changes to URLs and configurations are related to the same project, indicating a connection between the two.

Poem

🐰 Hop, hop, through the code we go,
From fluent to tiny, watch our project grow!
URLs dancing, links rearranged,
A bunny's guide to getting changed 🌈
Tiny Editor hops into the light! 🚀


📜 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 b5847f6 and 3cfa8e3.

📒 Files selected for processing (9)
  • .github/ISSUE_TEMPLATE/config.yml (1 hunks)
  • CONTRIBUTING.md (5 hunks)
  • CONTRIBUTING.zh-CN.md (5 hunks)
  • README.md (1 hunks)
  • README.zh-CN.md (1 hunks)
  • package.json (1 hunks)
  • packages/docs/fluent-editor/.vitepress/config.ts (2 hunks)
  • packages/docs/fluent-editor/index.md (1 hunks)
  • packages/fluent-editor/package.json (1 hunks)

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.

Copy link

Walkthrough

This pull request updates the documentation and configuration files to reflect a change in the project name from "fluent-editor" to "tiny-editor". It involves modifying URLs, references, and descriptions across multiple files to ensure consistency with the new project name.

Changes

Files Summary
.github/ISSUE_TEMPLATE/config.yml, package.json, packages/fluent-editor/package.json Updated URLs and references from "fluent-editor" to "tiny-editor".
CONTRIBUTING.md, CONTRIBUTING.zh-CN.md Updated contribution guidelines to reflect the new project name and URLs.
README.md, README.zh-CN.md Changed contributor links to the new repository name.
packages/docs/fluent-editor/.vitepress/config.ts, packages/docs/fluent-editor/index.md Updated documentation configuration and links to reflect the new project name.

@@ -6,8 +6,8 @@ import { sidebar } from './sidebar'
export default defineConfig({
title: 'TinyEditor',
titleTemplate: '基于 Quill 2.0 的富文本编辑器',
description: '富文本编辑器, Rich text editor, rich-text-editor, rich-text, wysiwyg, wysiwyg-editor, quill, fluent-editor',
base: '/fluent-editor/',
description: '富文本编辑器, Rich text editor, rich-text-editor, rich-text, wysiwyg, wysiwyg-editor, quill, fluent-editor, tiny-editor',

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure that the description accurately reflects the new project name and scope, as this impacts SEO and user understanding.

@kagol kagol merged commit 91d3250 into main Jan 17, 2025
2 of 3 checks passed
kagol added a commit that referenced this pull request Jan 17, 2025
kagol added a commit that referenced this pull request Jan 17, 2025
kagol added a commit that referenced this pull request Jan 25, 2025
kagol added a commit that referenced this pull request Jan 25, 2025
kagol added a commit that referenced this pull request Jan 25, 2025
@kagol kagol deleted the kagol/modify-fluent-editor-to-tiny-editor branch January 25, 2025 10:06
@kagol kagol added the v3 label Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation v3
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant