Skip to content

fix: readmes#888

Merged
ErnestM1234 merged 1 commit intomainfrom
e/fix-next-readme
Dec 11, 2025
Merged

fix: readmes#888
ErnestM1234 merged 1 commit intomainfrom
e/fix-next-readme

Conversation

@ErnestM1234
Copy link
Contributor

What

Fix read me for gt-next gt-react

Why

massively out dated

@ErnestM1234 ErnestM1234 requested a review from a team as a code owner December 11, 2025 21:03
@ErnestM1234 ErnestM1234 enabled auto-merge (squash) December 11, 2025 21:03
Copy link
Contributor

@SamEggert SamEggert left a comment

Choose a reason for hiding this comment

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

lgtm

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Dec 11, 2025

Greptile Overview

Greptile Summary

Updated README files for gt-next and gt-react packages to reflect current documentation structure and CLI package name change from gt-next-cli/gt-react-cli to gtx-cli.

  • Replaced outdated multi-step configuration instructions with links to Quick Start guides
  • Updated CLI package name to gtx-cli (correct according to packages/cli/package.json)
  • Streamlined getting started section with simplified examples
  • Added feature showcase sections (JSX translation, inline strings, dictionaries, pluralization, formatting)
  • Critical issue: Both READMEs contain identical syntax error - </divs> instead of </div> on line 31

Confidence Score: 3/5

  • PR updates outdated documentation but introduces syntax errors that need fixing before merge
  • Documentation updates are valuable and CLI package name change is correct, but the invalid JSX syntax (</divs>) in both README code examples needs to be corrected to prevent confusion for users following the documentation
  • Both packages/next/README.md and packages/react/README.md need the syntax error fixed on line 31

Important Files Changed

File Analysis

Filename Score Overview
packages/next/README.md 3/5 Updated documentation to reflect modern setup with gtx-cli and simplified examples; contains syntax error in closing tag (</divs> should be </div>)
packages/react/README.md 3/5 Updated documentation to reflect modern setup with gtx-cli and simplified examples; contains syntax error in closing tag (</divs> should be </div>)

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant PR as Pull Request #888
    participant CS as Changeset File
    participant NR as gt-next README
    participant RR as gt-react README
    
    Dev->>PR: Create PR to fix outdated READMEs
    Dev->>CS: Add changeset for patch release
    Note over CS: Marks gt-react & gt-next for patch
    
    Dev->>NR: Update installation instructions
    Note over NR: gt-next-cli → gtx-cli
    Dev->>NR: Simplify getting started guide
    Dev->>NR: Add feature examples
    Note over NR: Syntax error: </divs> introduced
    
    Dev->>RR: Update installation instructions
    Note over RR: gt-react-cli → gtx-cli
    Dev->>RR: Simplify getting started guide
    Dev->>RR: Add feature examples
    Note over RR: Syntax error: </divs> introduced
    
    PR->>Dev: Review identifies syntax errors
Loading

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

2 files reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

```jsx
<T>
<p>This gets translated!</p>
<div>This also gets translated!</divs>
Copy link
Contributor

Choose a reason for hiding this comment

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

syntax: closing </div> tag has typo - says </divs> instead of </div>

Suggested change
<div>This also gets translated!</divs>
<div>This also gets translated!</div>
Prompt To Fix With AI
This is a comment left during a code review.
Path: packages/next/README.md
Line: 31:31

Comment:
**syntax:** closing `</div>` tag has typo - says `</divs>` instead of `</div>`

```suggestion
  <div>This also gets translated!</div>
```

How can I resolve this? If you propose a fix, please make it concise.

```jsx
<T>
<p>This gets translated!</p>
<div>This also gets translated!</divs>
Copy link
Contributor

Choose a reason for hiding this comment

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

syntax: closing </div> tag has typo - says </divs> instead of </div>

Suggested change
<div>This also gets translated!</divs>
<div>This also gets translated!</div>
Prompt To Fix With AI
This is a comment left during a code review.
Path: packages/react/README.md
Line: 31:31

Comment:
**syntax:** closing `</div>` tag has typo - says `</divs>` instead of `</div>`

```suggestion
  <div>This also gets translated!</div>
```

How can I resolve this? If you propose a fix, please make it concise.

@ErnestM1234 ErnestM1234 merged commit 6314624 into main Dec 11, 2025
19 checks passed
@ErnestM1234 ErnestM1234 deleted the e/fix-next-readme branch December 11, 2025 21:10
@github-actions github-actions bot mentioned this pull request Dec 11, 2025
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.

2 participants