-
Notifications
You must be signed in to change notification settings - Fork 1
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
docs:update readme #277
docs:update readme #277
Conversation
WalkthroughThe recent update to the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
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.
Actionable comments posted: 0
Out of diff range and nitpick comments (7)
README.md (7)
Line range hint
5-6
: Remove multiple consecutive blank lines for better readability.- - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - +Also applies to: 10-12, 19-20, 29-30, 36-37, 43-44, 51-53, 66-68, 78-79, 87-88, 94-96
Line range hint
12-12
: Remove trailing spaces.- +Also applies to: 33-33
Line range hint
57-64
: Add alternate text to images for better accessibility.- <img src="https://github.com/wanderlust-group-project-1/wanderlust/blob/main/docs/1.png?raw=true" width="45%"> - <img src="https://github.com/wanderlust-group-project-1/wanderlust/blob/main/docs/2.png?raw=true" width="45%"> - <img src="https://github.com/wanderlust-group-project-1/wanderlust/blob/main/docs/3.png?raw=true" width="45%"> - <img src="https://github.com/wanderlust-group-project-1/wanderlust/blob/main/docs/4.png?raw=true" width="45%"> - <img src="https://github.com/wanderlust-group-project-1/wanderlust/blob/main/docs/5.png?raw=true" width="45%"> - <img src="https://github.com/wanderlust-group-project-1/wanderlust/blob/main/docs/6.png?raw=true" width="45%"> - <img src="https://github.com/wanderlust-group-project-1/wanderlust/blob/main/docs/7.png?raw=true" width="45%"> - <img src="https://github.com/wanderlust-group-project-1/wanderlust/blob/main/docs/8.png?raw=true" width="45%"> + <img src="https://github.com/wanderlust-group-project-1/wanderlust/blob/main/docs/1.png?raw=true" width="45%" alt="Screenshot 1"> + <img src="https://github.com/wanderlust-group-project-1/wanderlust/blob/main/docs/2.png?raw=true" width="45%" alt="Screenshot 2"> + <img src="https://github.com/wanderlust-group-project-1/wanderlust/blob/main/docs/3.png?raw=true" width="45%" alt="Screenshot 3"> + <img src="https://github.com/wanderlust-group-project-1/wanderlust/blob/main/docs/4.png?raw=true" width="45%" alt="Screenshot 4"> + <img src="https://github.com/wanderlust-group-project-1/wanderlust/blob/main/docs/5.png?raw=true" width="45%" alt="Screenshot 5"> + <img src="https://github.com/wanderlust-group-project-1/wanderlust/blob/main/docs/6.png?raw=true" width="45%" alt="Screenshot 6"> + <img src="https://github.com/wanderlust-group-project-1/wanderlust/blob/main/docs/7.png?raw=true" width="45%" alt="Screenshot 7"> + <img src="https://github.com/wanderlust-group-project-1/wanderlust/blob/main/docs/8.png?raw=true" width="45%" alt="Screenshot 8">
Line range hint
88-88
: Avoid using multiple top-level headings in the same document.Consider using subheadings or restructuring the document to maintain a single top-level heading.
Line range hint
116-116
: Surround fenced code blocks with blank lines for better readability.- ```bash + + ```bash
Line range hint
125-131
: Avoid using bare URLs. Convert them to clickable links.- Or open PHPMyAdmin at `http://localhost:8007` and import the `wanderlust.sql` file + Or open PHPMyAdmin at [http://localhost:8007](http://localhost:8007) and import the `wanderlust.sql` file
Line range hint
131-131
: Ensure the file ends with a single newline character.- admin@wl.com | Admin1234 + admin@wl.com | Admin1234 +
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (1 hunks)
Additional comments not posted (1)
README.md (1)
100-101
: The addition of the site availability information is correct and useful.
Summary by CodeRabbit
http://localhost:8000
.