Conversation
admin_pages_dev: Modified ReadMe file and some component attributes
Reviewer's GuideThis PR overhauls the project README by renaming and reorganizing sections, updating image paths and tables, adding new screenshots and deployment visuals; it also refines the admin sidebar navigation links and tweaks a CSS layout margin. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey @Riyad-Murad - I've reviewed your changes - here's some feedback:
- The README section headings and content have been reorganized but seem inconsistent in naming and ordering—consider standardizing heading titles and grouping related sections for clarity.
- Several image filenames and paths include spaces and URL-encoded characters which may lead to broken links—renaming files to remove spaces and updating paths accordingly will improve reliability.
- Instead of using a hardcoded
margin-left: 400pxin styles.css, consider leveraging flexbox or grid layouts to ensure responsive alignment across different viewports.
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
|
||
| ### Project Box Design | ||
|
|
||
| This box is a demostration of a power room that contain elecrical wire lines and the microcontroller is connected to the circuit. |
There was a problem hiding this comment.
issue (typo): Multiple typos and grammatical error in sentence.
Change 'demostration' to 'demonstration', 'contain' to 'contains', and 'elecrical' to 'electrical'. Also, rephrase 'electrical wire lines' to 'electrical wiring' or 'electrical lines'.
| This box is a demostration of a power room that contain elecrical wire lines and the microcontroller is connected to the circuit. | |
| This box is a demonstration of a power room that contains electrical wiring, and the microcontroller is connected to the circuit. |
|
|
||
| | AWS S3 Bucket React files | S3 bucket public IP website | | ||
| | --------------------------------------- | ------------------------------------- | | ||
| |  |  | |
There was a problem hiding this comment.
issue: Placeholder and non-descriptive alt texts for deployment images.
Change the second image’s alt text (fsdaf) to a descriptive label (e.g., “S3 Deployed Website”) and refine the first image’s alt text (Landing) to clearly convey the React files in the AWS S3 bucket (e.g., “AWS S3 Bucket React Files”).
Summary by Sourcery
Reorganize README documentation to reflect staging updates, refresh UI demo visuals, add deployment snapshots, and refine admin sidebar navigation and layout styling.
Enhancements:
Documentation: