search

mincho-js / mincho

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

Docs: README update #60 #65

Closed black7375 closed 2 months ago

black7375 commented 2 months ago

Description

Update the documentation before releasing.

Related Issue

Summary by CodeRabbit

Additional context

Checklist

changeset-bot[bot] commented 2 months ago

⚠️ No Changeset found

Latest commit: 550e404cf7a55978b405ed67d5198cc2da5127bb

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.

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 updates enhance the documentation across multiple packages of the @mincho-js project. Key changes include improved clarity and organization in the README.md files, the addition of installation instructions, detailed API descriptions, and usage examples, all aimed at providing users with better guidance and understanding of the features and functionalities available.

Changes

Files Change Summary
README.md Updated project readiness to "WIP", added "Documentation" section for navigation.
packages/css-additional-types/README.md Added installation instructions and detailed API section with type descriptions.
packages/css/README.md Expanded introduction, added installation instructions, usage examples, and an API section.
packages/debug-log/README.md Included a new installation section for ease of use.
packages/transform-to-vanilla/README.md Introduced installation instructions and an API section detailing the transform function.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Package

    User->>CLI: Install package
    CLI->>Package: Fetch installation instructions
    Package-->>CLI: Return instructions
    CLI-->>User: Display instructions
    User->>Package: Use API functions
    Package-->>User: Execute functions

Poem

🐇 In the meadow bright and green,
Changes hop with joy, unseen,
New docs to guide, a clearer way,
Install with ease, start today!
With functions ready, a joyful dance,
Embrace the code, give it a chance! 🌼

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/65 by @​black7375.

Checking if we can fast forward main (031899722227fe188d15572a51625b258fffaa4f) to publish/css (550e404cf7a55978b405ed67d5198cc2da5127bb).

Target branch (main):

commit 031899722227fe188d15572a51625b258fffaa4f (HEAD -> main, origin/main, origin/HEAD)
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Mon Aug 12 12:22:23 2024 +0000

    Chore(deps-dev): Bump @types/node from 20.14.11 to 22.2.0

    Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 20.14.11 to 22.2.0.
    - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
    - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

    ---
    updated-dependencies:
    - dependency-name: "@types/node"
      dependency-type: direct:development
      update-type: version-update:semver-major
    ...

    Signed-off-by: dependabot[bot] <support@github.com>

Pull request (publish/css):

commit 550e404cf7a55978b405ed67d5198cc2da5127bb (pull_request/publish/css)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Thu Aug 15 18:49:54 2024 +0900

    Docs: README update #60

It is possible to fast forward main (031899722227fe188d15572a51625b258fffaa4f) to publish/css (550e404cf7a55978b405ed67d5198cc2da5127bb). If you have write access to the target repository, you can add a comment with /fast-forward to fast forward main to publish/css.

black7375 commented 2 months ago

/fast-forward

github-actions[bot] commented 2 months ago

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

Trying to fast forward main (031899722227fe188d15572a51625b258fffaa4f) to publish/css (550e404cf7a55978b405ed67d5198cc2da5127bb).

Target branch (main):

commit 031899722227fe188d15572a51625b258fffaa4f (HEAD -> main, origin/main, origin/HEAD)
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Mon Aug 12 12:22:23 2024 +0000

    Chore(deps-dev): Bump @types/node from 20.14.11 to 22.2.0

    Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 20.14.11 to 22.2.0.
    - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
    - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

    ---
    updated-dependencies:
    - dependency-name: "@types/node"
      dependency-type: direct:development
      update-type: version-update:semver-major
    ...

    Signed-off-by: dependabot[bot] <support@github.com>

Pull request (publish/css):

commit 550e404cf7a55978b405ed67d5198cc2da5127bb (pull_request/publish/css)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Thu Aug 15 18:49:54 2024 +0900

    Docs: README update #60

Fast forwarding main (031899722227fe188d15572a51625b258fffaa4f) to publish/css (550e404cf7a55978b405ed67d5198cc2da5127bb).

$ git push origin 550e404cf7a55978b405ed67d5198cc2da5127bb:main
To https://github.com/mincho-js/mincho.git
   0318997..550e404  550e404cf7a55978b405ed67d5198cc2da5127bb -> main