feat(sistent): add Table component documentation#7610
feat(sistent): add Table component documentation#7610Sohamsig wants to merge 3 commits intolayer5io:masterfrom
Conversation
f51f3b9 to
9b7a07a
Compare
|
@rishiraj38 Hi, I’ve completed the changes for this issue. |
rishiraj38
left a comment
There was a problem hiding this comment.
Please refer to the other components present there; this, in my opinion, is not the correct implementation.
There was a problem hiding this comment.
This navigation is also incorrect.
| @@ -0,0 +1,18 @@ | |||
| --- | |||
| title: Table | |||
There was a problem hiding this comment.
This isn’t right; we have more fields here.
|
@Sohamsig, will you be able to do this? I see you’re a first-time contributor so it might be a bit overwhelming. |
2fee297 to
582b087
Compare
|
@rishiraj38 Yes, I've already addressed the comments and updated the PR. |
|
@rishiraj38 Hi 👋 Could you please guide me on whether |
daf7d3f to
00eba17
Compare
There was a problem hiding this comment.
Please remove this file; we no longer need it.
|
@Sohamsig, please check for build failures. |
rishiraj38
left a comment
There was a problem hiding this comment.
The build fails because ThemeWrapper and CodeBlock are being manually imported on lines 8 and 9 using an incorrect path. Since these are global components in our MDX setup simply removing those import lines will resolve the build error.
rishiraj38
left a comment
There was a problem hiding this comment.
- Fix Build Error: In code.mdx, please remove the manual import ThemeWrapper and CodeBlock lines. These components are already provided globally by our MDX template, and the manual imports are currently breaking the CI build.
- Use Sistent Components: For the examples in code.mdx and the overview in index.mdx, please use the official sub-components from @sistent/sistent (e.g., Table, TableBody, TableCell, TableContainer, TableHead, and TableRow) instead of raw HTML tags or the specialized ConformanceTest-Table.
- Follow Documentation Standards: As mentioned in the issue, the documentation should match the style and depth of the Button component. This includes wrapping live demos in and using / for layout consistency.
- Demonstrate States: The issue explicitly asks for examples of various states (sortable, selectable rows, paginated). Using the @sistent/sistent components mentioned above will allow you to correctly showcase these features.
Could you also flesh out the Guidance section with some best practices and stylistic tips to match our other core documentation? Let me know if you have any questions!
Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
0f9866f to
d74a725
Compare
|
🚀 Preview deployment: https://layer5io.github.io/layer5/pr-preview/pr-7610/ |
|
@rishiraj38 Thanks for the detailed feedback! I've addressed the requested changes:
The CI checks are currently running. Please let me know if any further improvements are needed. |
rishiraj38
left a comment
There was a problem hiding this comment.
Please add a collapsible CodeBlock and insert the corresponding code within it.
Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
cc91e96 to
fcfaf46
Compare
|
@rishiraj38 I've added collapsible CodeBlock sections for each example and included the corresponding code within them. Please let me know if any further improvements are needed. |
This PR adds documentation for the Table component in Sistent.
Added:
Also updated navigation for Table component.