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 PT-BR readme support #1904

Open
wants to merge 35 commits into
base: main
Choose a base branch
from

Conversation

jonathas3c
Copy link

@jonathas3c jonathas3c commented Feb 23, 2024

This PR implements:

  • Brazilian Portuguese (PT-BR) support for readme.md;
  • Proper redirection to Arabic readme version in languages ES, FR and RU;

Summary by CodeRabbit

  • Documentation
    • Added a link to the Brazilian Portuguese version across all README files.
    • Corrected and updated the link to the Arabic README file.
    • Enhanced README files with comprehensive information about OpenReplay, including features, integrations, deployment options, and community support details.

Amirouche and others added 30 commits January 26, 2024 18:11
Signed-off-by: rjshrjndrn <rjshrjndrn@gmail.com>
Co-authored-by: keshav-multi <keshav@multivariate.tech>
Signed-off-by: rjshrjndrn <rjshrjndrn@gmail.com>
Signed-off-by: rjshrjndrn <rjshrjndrn@gmail.com>
* Updated hero

* Fixed typo and added feature flags

* Typo
* fix(scrips) fix docker installation commands

* fix(scripts) check docker compose installation

* fix(script) revert scripts styles
Signed-off-by: rjshrjndrn <rjshrjndrn@gmail.com>
Signed-off-by: rjshrjndrn <rjshrjndrn@gmail.com>
Signed-off-by: rjshrjndrn <rjshrjndrn@gmail.com>
Signed-off-by: Rajesh Rajendran <rjshrjndrn@gmail.com>
Signed-off-by: rjshrjndrn <rjshrjndrn@gmail.com>
Signed-off-by: rjshrjndrn <rjshrjndrn@gmail.com>
Signed-off-by: rjshrjndrn <rjshrjndrn@gmail.com>
Signed-off-by: rjshrjndrn <rjshrjndrn@gmail.com>
* fix(tracker): change canvas scaling

* fix(tracker): 12.0.3

* fix(tracker): 12.0.3
Signed-off-by: rjshrjndrn <rjshrjndrn@gmail.com>
* change(ui): iframe check for sso redirect

* change(ui): removed login.js

* change(ui): sso link

* change(ui): sso link

* change(ui): iframe check and sso redirect
Copy link

coderabbitai bot commented Feb 23, 2024

Walkthrough

The update introduces a link to the Brazilian Portuguese README, corrects the Arabic README link, and details OpenReplay's features. It emphasizes session replay, DevTools, and more for web/mobile apps, highlighting its community-driven, plugin-oriented architecture with various deployment options and privacy controls.

Changes

Files Change Summaries
README.md, README_AR.md, README_ESP.md, README_FR.md, README_RU.md Added link to Brazilian Portuguese README, corrected and updated Arabic README link, introduced OpenReplay details.

🐇✨
In the realm of code, where changes abound,
A rabbit hopped in, leaving footprints on the ground.
Links were tweaked, and details unfurled,
About a tool that watches over the digital world.
With every hop and every bound,
A more connected world is found.
🚀🌐

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 2c31a23 and 5d9f708.
Files selected for processing (6)
  • README.md (1 hunks)
  • README_AR.md (1 hunks)
  • README_ESP.md (1 hunks)
  • README_FR.md (1 hunks)
  • README_PTBR.md (1 hunks)
  • README_RU.md (1 hunks)
Additional comments: 8
README_AR.md (1)
  • 6-6: The addition of the Brazilian Portuguese (PT-BR) README link is correctly formatted and placed, enhancing the accessibility of the documentation for Portuguese-speaking users.
README.md (1)
  • 6-6: The addition of the Brazilian Portuguese (PT-BR) README link is correctly formatted and placed, enhancing the accessibility of the documentation for Portuguese-speaking users.
README_RU.md (1)
  • 10-10: The correction of the link to the Arabic README file and the addition of the Brazilian Portuguese (PT-BR) README link are both correctly formatted and placed, addressing navigation issues and enhancing documentation accessibility.
README_ESP.md (2)
  • 6-6: The addition of the link to the Portuguese (Brazil) README file (README_PTBR.md) is correctly implemented and follows the established pattern for linking to other language versions of the README file.
  • 10-10: The correction of the link to the Arabic README file (README_AR.md) is correctly implemented. This ensures users navigating from the Spanish README file are accurately directed to the Arabic version, improving the navigation experience.
README_PTBR.md (1)
  • 1-105: The Brazilian Portuguese README file is a valuable addition to the project, making the documentation accessible to Portuguese-speaking users. The language links at the top are correctly implemented, ensuring users can easily navigate between different language versions of the README. The content is well-structured and follows the project's documentation standards, providing a comprehensive overview of OpenReplay's features, deployment options, community support, and more.
README_FR.md (2)
  • 6-6: The addition of the link to the Brazilian Portuguese version (README_PTBR.md) is correctly implemented and follows the established pattern for linking to other language versions of the README file.
  • 10-10: The correction of the link to the Arabic README file (README_AR.md) is correctly implemented. This ensures users navigating from the French README file are accurately directed to the Arabic version, improving the navigation experience.

@jonathas3c jonathas3c changed the title (docs): Add PT-BR readme support docs: Add PT-BR readme support Feb 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants