search

mincho-js / mincho

Natural CSS in TypeScript
MIT License
40 stars 0 forks source link

Docs: Edit sentences and add Twitter accounts #60 #76

Closed black7375 closed 2 months ago

black7375 commented 2 months ago

Description

Minor README update.

Related Issue

Summary by CodeRabbit

Additional context

Checklist

changeset-bot[bot] commented 2 months ago

⚠️ No Changeset found

Latest commit: ce041cebcc0aede732952d3980b2450f3473f3be

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent changes across various documentation files focus on enhancing clarity, consistency, and engagement. Key updates include correcting terminology, improving phrasing for better understanding, and promoting social media interaction through badges. These adjustments aim to refine the user experience without altering any core functionalities.

Changes

Files Change Summary
CONTRIBUTING.md, README.md, packages/css/README.md Minor textual adjustments for clarity and consistency, including correcting "Typescript" to "TypeScript" and adding a Twitter follow badge.
packages/css-additional-types/README.md Textual corrections enhancing clarity, including changing "the type generated" to "types generated" and refining terminology from "kebabs" to "kebab-case."
packages/transform-to-vanilla/README.md Wording change from "CSS in JS syntax converted for [Vanilla Extract]" to "CSS in JS syntax converter for [Vanilla Extract]" for clarity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Documentation
    participant SocialMedia

    User->>Documentation: View updated documentation
    Documentation-->>User: Display corrected terms and new badges
    User->>SocialMedia: Follow project on Twitter

Poem

🐇
In the garden of code, we make it bright,
With words that shine, oh what a sight!
From Typescript to badges, all in play,
We hop through changes, come join the fray!
Clear and concise, like a bunny's dash,
Together we build, with joy and a splash!
🌼

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 2 months ago

Triggered from https://github.com/mincho-js/mincho/pull/76 by @​black7375.

Checking if we can fast forward main (80b352b3fce7b3b06b6b83eb258cf38f511ef9ee) to update-readme (ce041cebcc0aede732952d3980b2450f3473f3be).

Target branch (main):

commit 80b352b3fce7b3b06b6b83eb258cf38f511ef9ee (HEAD -> main, origin/main, origin/HEAD)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Sat Aug 17 17:57:42 2024 +0900

    Chore: Combine fast forward and release workflows again #69

Pull request (update-readme):

commit ce041cebcc0aede732952d3980b2450f3473f3be (pull_request/update-readme)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Sat Aug 17 19:10:28 2024 +0900

    Docs: Edit sentences and add Twitter accounts #60

It is possible to fast forward main (80b352b3fce7b3b06b6b83eb258cf38f511ef9ee) to update-readme (ce041cebcc0aede732952d3980b2450f3473f3be). If you have write access to the target repository, you can add a comment with /fast-forward to fast forward main to update-readme.

black7375 commented 2 months ago

/fast-forward

github-actions[bot] commented 2 months ago

Triggered from https://github.com/mincho-js/mincho/pull/76#issuecomment-2294818074 by @​black7375.

Trying to fast forward main (80b352b3fce7b3b06b6b83eb258cf38f511ef9ee) to update-readme (ce041cebcc0aede732952d3980b2450f3473f3be).

Target branch (main):

commit 80b352b3fce7b3b06b6b83eb258cf38f511ef9ee (HEAD -> main, origin/main, origin/HEAD)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Sat Aug 17 17:57:42 2024 +0900

    Chore: Combine fast forward and release workflows again #69

Pull request (update-readme):

commit ce041cebcc0aede732952d3980b2450f3473f3be (pull_request/update-readme)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Sat Aug 17 19:10:28 2024 +0900

    Docs: Edit sentences and add Twitter accounts #60

Fast forwarding main (80b352b3fce7b3b06b6b83eb258cf38f511ef9ee) to update-readme (ce041cebcc0aede732952d3980b2450f3473f3be).

$ git push origin ce041cebcc0aede732952d3980b2450f3473f3be:main
To https://github.com/mincho-js/mincho.git
   80b352b..ce041ce  ce041cebcc0aede732952d3980b2450f3473f3be -> main