-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Enhanced modal guidance documentation while maintaining consistency #6367
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: Souradip Pal <souradip1000@gmail.com>
@vishalvivekm take a look at my changes |
🚀 Preview for commit 8f441a1 at: https://67ece58889990cd3f22385e3--layer5.netlify.app |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR enhances the modal documentation and consistency by introducing new styled components for documentation tables, refining guidance content, and updating code examples.
- Introduces new styled components (DocsTable, TableHead, TableBody, guidance list styles)
- Updates modal navigation (TabButton routes) and documentation structure in the modal guidance and code examples
- Refines inline styling and code snippet examples for clarity and consistency
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
File | Description |
---|---|
src/sections/Projects/Sistent/sistent.style.js | Adds styled components for documentation tables and guidance list styling |
src/sections/Projects/Sistent/components/modal/index.js | Removes redundant commented code and corrects TabButton navigation |
src/sections/Projects/Sistent/components/modal/guidance.js | Reorders imports, applies dark mode hook, and improves guidance section structure |
src/sections/Projects/Sistent/components/modal/code.js | Updates code examples with refined button styling, documentation tables, and snippet improvements |
Comments suppressed due to low confidence (1)
src/sections/Projects/Sistent/components/modal/code.js:103
- The usage of the 'text' prop for CustomInput differs from the previous usage with the 'label' prop; ensure that the CustomInput component implementation is updated accordingly, or revert the prop change to maintain consistency.
<CustomInput text="Name" />
@@ -36,48 +36,85 @@ const CustomInput = ({ label, text, style }) => ( | |||
</Box> | |||
); | |||
|
|||
const importExample = `// Import the necessary components |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code example uses useState to manage modal visibility without including its import; consider adding an import statement (e.g., 'import React, { useState } from "react";') for completeness in the snippet.
const importExample = `// Import the necessary components | |
const importExample = `// Import the necessary components | |
import React, { useState } from "react"; |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
Description
This PR fixes #6292
Notes for Reviewers
I have put consistent styling along with implementing guidance section and elaborating on the code section with basic imports
2025-04-02.12-32-50.mp4
Signed commits