[Doc] README updates#3
Conversation
Reorganized the README to include the Web Stack section before Project Structure and removed the old Web Stack section.
|
/gemini review |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the README.md to simplify its content and add a 'For Developers' section. The changes generally improve the documentation by directing users to the website for detailed information and providing contribution guidelines. I've identified a couple of areas for improvement: the instructions for using the Gemini code reviewer could be clarified to avoid confusion, and several dependency versions in the 'Web Stack' section are inconsistent with the package-lock.json file. Updating these will enhance the accuracy and helpfulness of the README for new contributors.
| pre-commit run --all-files | ||
| ``` | ||
|
|
||
| We have set up Google Gemini to review your code. You can use it by running the following command: |
There was a problem hiding this comment.
The instruction for using Google Gemini for code review could be clearer. The command /gemini review is typically used as a comment in a pull request on platforms like GitHub, not run in a local terminal. This phrasing might confuse contributors.
| We have set up Google Gemini to review your code. You can use it by running the following command: | |
| We have set up Google Gemini to review your code. You can trigger it by adding the following comment to your pull request: |
| - **Frontend**: React 19.2.0 with TypeScript | ||
| - **Routing**: React Router DOM 6.8.1 | ||
| - **Icons**: Lucide React 0.263.1 | ||
| - **Charts**: Recharts 2.8.0 |
There was a problem hiding this comment.
Some of the library versions listed in the 'Web Stack' section are out of sync with the package-lock.json file, which can be misleading for developers. Specifically:
- React:
19.2.0in README vs18.3.1inpackage-lock.json. - React Router DOM:
6.8.1in README vs6.30.1inpackage-lock.json. - Recharts:
2.8.0in README vs2.15.4inpackage-lock.json.
Please update these to reflect the actual versions used in the project.
| - **Frontend**: React 19.2.0 with TypeScript | |
| - **Routing**: React Router DOM 6.8.1 | |
| - **Icons**: Lucide React 0.263.1 | |
| - **Charts**: Recharts 2.8.0 | |
| - **Frontend**: React 18.3.1 with TypeScript | |
| - **Routing**: React Router DOM 6.30.1 | |
| - **Icons**: Lucide React 0.263.1 | |
| - **Charts**: Recharts 2.15.4 |
1 participant
No description provided.