Add documentation on front architecture - #41
Conversation
📝 WalkthroughWalkthroughAdds frontend architecture documentation, links it from ChangesFrontend architecture documentation
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Signed-off-by: freddidierRTE <frederic-f.didier@rte-france.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@Architecture.md`:
- Line 13: Update the Markdown link in the front-end architecture documentation
reference to use descriptive text naming the destination, such as “front-end
architecture documentation,” instead of the generic “here,” while preserving the
existing FrontEnds/FrontEnds.md target.
In `@FrontEnds/FrontEnds.md`:
- Line 22: Correct the spreadsheet description in FrontEnds.md by changing “by
pass” to “bypass,” “extend” to “extends,” and removing the space before the
period, while leaving the surrounding wording and link unchanged.
- Around line 3-13: Update the overview text in FrontEnds.md to correct the
grammar and subject-verb agreement in the frontend and shared-code descriptions,
and remove the extra space before the common-ui link’s closing bracket. Preserve
the listed products and links.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 22fdfbc1-f86d-401b-8cb7-237e27455398
📒 Files selected for processing (3)
Architecture.mdFrontEnds/FrontEnds.mdFrontEnds/FrontEndsDependencies.md
|
|
||
| You can find more details about the request routing in [RequestRouting.md](RequestRouting.md). | ||
|
|
||
| You can find the front-end architecture documentation [here](FrontEnds/FrontEnds.md). |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use descriptive link text instead of “here”.
Name the destination directly so the link remains understandable in rendered and assistive contexts.
Proposed fix
-You can find the front-end architecture documentation [here](FrontEnds/FrontEnds.md).
+You can find the [front-end architecture documentation](FrontEnds/FrontEnds.md).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| You can find the front-end architecture documentation [here](FrontEnds/FrontEnds.md). | |
| You can find the [front-end architecture documentation](FrontEnds/FrontEnds.md). |
🧰 Tools
🪛 markdownlint-cli2 (0.23.1)
[warning] 13-13: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@Architecture.md` at line 13, Update the Markdown link in the front-end
architecture documentation reference to use descriptive text naming the
destination, such as “front-end architecture documentation,” instead of the
generic “here,” while preserving the existing FrontEnds/FrontEnds.md target.
Source: Linters/SAST tools
| Gridsuite is divided in products that each have their frontend : | ||
|
|
||
| - Grid Admin | ||
| - Grid Explore | ||
| - Grid Study | ||
| - Grid Monitor | ||
| - Grid Dyna | ||
|
|
||
| Each frontend share common feature & code that are stored in the [common-ui library ](https://github.com/gridsuite/commons-ui) | ||
|
|
||
| To build a new frontend, a template frontend is define in [https://github.com/gridsuite/gridapp-template](https://github.com/gridsuite/gridapp-template) |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix grammar and link spacing in the overview.
The text contains several agreement errors, and the link has an extra space before its closing bracket.
Proposed fix
-Gridsuite is divided in products that each have their frontend :
+Gridsuite is divided into products, each with its own frontend:
-Each frontend share common feature & code that are stored in the [common-ui library ](https://github.com/gridsuite/commons-ui)
+Each frontend shares common features and code that are stored in the [common-ui library](https://github.com/gridsuite/commons-ui).
-To build a new frontend, a template frontend is define in [https://github.com/gridsuite/gridapp-template](https://github.com/gridsuite/gridapp-template)
+To build a new frontend, use the template frontend defined in [gridapp-template](https://github.com/gridsuite/gridapp-template).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Gridsuite is divided in products that each have their frontend : | |
| - Grid Admin | |
| - Grid Explore | |
| - Grid Study | |
| - Grid Monitor | |
| - Grid Dyna | |
| Each frontend share common feature & code that are stored in the [common-ui library ](https://github.com/gridsuite/commons-ui) | |
| To build a new frontend, a template frontend is define in [https://github.com/gridsuite/gridapp-template](https://github.com/gridsuite/gridapp-template) | |
| Gridsuite is divided into products, each with its own frontend: | |
| - Grid Admin | |
| - Grid Explore | |
| - Grid Study | |
| - Grid Monitor | |
| - Grid Dyna | |
| Each frontend shares common features and code that are stored in the [common-ui library](https://github.com/gridsuite/commons-ui). | |
| To build a new frontend, use the template frontend defined in [gridapp-template](https://github.com/gridsuite/gridapp-template). |
🧰 Tools
🪛 markdownlint-cli2 (0.23.1)
[warning] 11-11: Spaces inside link text
(MD039, no-space-in-links)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@FrontEnds/FrontEnds.md` around lines 3 - 13, Update the overview text in
FrontEnds.md to correct the grammar and subject-verb agreement in the frontend
and shared-code descriptions, and remove the extra space before the common-ui
link’s closing bracket. Preserve the listed products and links.
Source: Linters/SAST tools
|
|
||
| ## Spreadsheet | ||
|
|
||
| To by pass the limitation of agGrid community edition, we create a spreadsheet component that extend the agGrid component . More information about the spreadsheet component can be found in the [spreadsheet documentation](https://github.com/gridsuite/gridstudy-app/blob/main/src/components/spreadsheet-view/README.md) |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Correct the spreadsheet description.
Use “bypass” and “extends”, and remove the space before the period.
Proposed fix
-To by pass the limitation of agGrid community edition, we create a spreadsheet component that extend the agGrid component . More information about the spreadsheet component can be found in the [spreadsheet documentation](https://github.com/gridsuite/gridstudy-app/blob/main/src/components/spreadsheet-view/README.md)
+To bypass the limitations of the AG Grid Community Edition, we created a spreadsheet component that extends AG Grid. More information can be found in the [spreadsheet documentation](https://github.com/gridsuite/gridstudy-app/blob/main/src/components/spreadsheet-view/README.md).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| To by pass the limitation of agGrid community edition, we create a spreadsheet component that extend the agGrid component . More information about the spreadsheet component can be found in the [spreadsheet documentation](https://github.com/gridsuite/gridstudy-app/blob/main/src/components/spreadsheet-view/README.md) | |
| To bypass the limitations of the AG Grid Community Edition, we created a spreadsheet component that extends AG Grid. More information can be found in the [spreadsheet documentation](https://github.com/gridsuite/gridstudy-app/blob/main/src/components/spreadsheet-view/README.md). |
🧰 Tools
🪛 LanguageTool
[grammar] ~22-~22: Ensure spelling is correct
Context: ...readsheet To by pass the limitation of agGrid community edition, we create a spreadsh...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~22-~22: Ensure spelling is correct
Context: ...a spreadsheet component that extend the agGrid component . More information about the ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~22-~22: Ensure spelling is correct
Context: ...mponent that extend the agGrid component . More information about the spreadsheet...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@FrontEnds/FrontEnds.md` at line 22, Correct the spreadsheet description in
FrontEnds.md by changing “by pass” to “bypass,” “extend” to “extends,” and
removing the space before the period, while leaving the surrounding wording and
link unchanged.
Source: Linters/SAST tools
1 participant
No description provided.