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: add Japanese README #272

Merged
merged 1 commit into from
Jul 10, 2024

Conversation

eltociear
Copy link
Contributor

@eltociear eltociear commented Jul 9, 2024

User description

I created Japanese translated README.


PR Type

Documentation


Description

  • Added a new Japanese README file (README-JP.md) with comprehensive documentation including introduction, features, getting started guides for Python and JavaScript, examples, and contribution guidelines.
  • Updated the language selection section in README.md and README-CN.md to include a link to the new Japanese README.

Changes walkthrough 📝

Relevant files
Documentation
README-CN.md
Add link to Japanese README in language selection               

README-CN.md

  • Added link to Japanese README (README-JP.md) in the language selection
    section.
  • +1/-1     
    README-JP.md
    Add Japanese README with comprehensive documentation         

    README-JP.md

  • Created a new Japanese README file.
  • Included sections such as introduction, features, getting started with
    Python and JavaScript, examples, and contribution guidelines.
  • +284/-0 
    README.md
    Add link to Japanese README in language selection               

    README.md

  • Added link to Japanese README (README-JP.md) in the language selection
    section.
  • +1/-1     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    Copy link

    ellipsis-dev bot commented Jul 9, 2024

    Your free trial has expired. To keep using Ellipsis, sign up at https://app.ellipsis.dev for $20/seat/month or reach us at [email protected]

    @codiumai-pr-agent-pro codiumai-pr-agent-pro bot added documentation Improvements or additions to documentation Review effort [1-5]: 2 labels Jul 9, 2024
    Copy link

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review

    Copy link

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Best practice
    Use relative paths for image sources to ensure consistency and avoid broken links

    To ensure consistency and avoid potential issues with broken links, consider using
    relative paths for the image sources instead of absolute paths.

    README-JP.md [7]

    -<img src="./python/docs/imgs/composio_white_font.svg" width="318px" alt="Composio ロゴ" />
    +<img src="../python/docs/imgs/composio_white_font.svg" width="318px" alt="Composio ロゴ" />
     
    • Apply this suggestion
    Suggestion importance[1-10]: 6

    Why: The suggestion to use relative paths for image sources is valid and improves maintainability, but it's a minor improvement.

    6
    Add syntax highlighting to code blocks for better readability

    To ensure the code examples are correctly formatted and easy to read, consider adding
    syntax highlighting to the code blocks.

    README-JP.md [112-114]

    +```bash
    +pip install composio-core
    +```
     
    -
    • Apply this suggestion
    Suggestion importance[1-10]: 6

    Why: Adding syntax highlighting to code blocks significantly improves readability and understanding, which is important for technical documentation.

    6
    Enhancement
    Add tooltips to social media icons for better user experience

    To enhance user experience, consider adding a tooltip to the social media icons to provide
    additional context when users hover over the links.

    README-JP.md [49-52]

    -<a href="https://dub.composio.dev/JoinHQ">Discord</a> <b>|</b> <a href="https://www.youtube.com/@Composio">Youtube</a> <b>|</b> <a href="https://twitter.com/composiohq">Twitter</a> <b>|</b> <a href="https://www.linkedin.com/company/composio-dev">LinkedIn</a>
    +<a href="https://dub.composio.dev/JoinHQ" title="Join us on Discord">Discord</a> <b>|</b> <a href="https://www.youtube.com/@Composio" title="Subscribe to our Youtube channel">Youtube</a> <b>|</b> <a href="https://twitter.com/composiohq" title="Follow us on Twitter">Twitter</a> <b>|</b> <a href="https://www.linkedin.com/company/composio-dev" title="Connect with us on LinkedIn">LinkedIn</a>
     
    • Apply this suggestion
    Suggestion importance[1-10]: 5

    Why: Adding tooltips to social media icons enhances user experience by providing additional context, which is a beneficial but not critical improvement.

    5
    Add spaces around pipe characters in navigation links for better readability

    To improve the readability and maintainability of the document, consider adding a space
    before and after the pipe (|) characters in the navigation links.

    README-JP.md [38-41]

    -<a href="https://docs.composio.dev">ダッシュボードで試す</a><b>|</b><a href="https://www.composio.dev">ホームページ</a><b>|</b><a href="https://docs.composio.dev/sdk">SDK</a><b>|</b><a href="https://docs.composio.dev/api-reference/">API</a>
    +<a href="https://docs.composio.dev">ダッシュボードで試す</a> <b>|</b> <a href="https://www.composio.dev">ホームページ</a> <b>|</b> <a href="https://docs.composio.dev/sdk">SDK</a> <b>|</b> <a href="https://docs.composio.dev/api-reference/">API</a>
     
    • Apply this suggestion
    Suggestion importance[1-10]: 4

    Why: Adding spaces around pipe characters is a minor stylistic change that slightly improves readability.

    4

    @kaavee315
    Copy link
    Contributor

    PR Summary

    Changes Introduced:

    • Added a new Japanese README file (README-JP.md) to provide documentation in Japanese.
    • Updated the existing README files (README.md and README-CN.md) to include a link to the new Japanese README.

    Objective:
    To enhance internationalization support by adding Japanese documentation, thereby making the project more accessible to Japanese-speaking users and contributors.

    Category:
    Doc

    Affected Files:

    1. README-CN.md - Modified to add a link to the Japanese README.
    2. README-JP.md - Newly added file containing the Japanese translation of the README.
    3. README.md - Modified to add a link to the Japanese README.

    Important Details:

    • The new README-JP.md file includes comprehensive documentation translated into Japanese.
    • Links to the Japanese README are now available in both the main README and the Chinese README.

    @kaavee315 kaavee315 merged commit 57f8ea4 into ComposioHQ:master Jul 10, 2024
    2 of 5 checks passed
    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 Review effort [1-5]: 2
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants