updating - intro-sql and sql-setup-env #238
Conversation
|
@meetoza30 is attempting to deploy a commit to the recode Team on Vercel. A member of the Team first needs to authorize it. |
|
Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. The estimated time for response is 5–8 hrs. In the meantime, please provide all necessary screenshots and make sure you run - npm build run , command and provide a screenshot, a video recording, or an image of the update you made below, which helps speed up the review and assignment. If you have questions, reach out to LinkedIn. Your contributions are highly appreciated!😊 Note: I maintain the repo issue every day twice at 8:00 AM IST and 9:00 PM IST. If your PR goes stale for more than one day, you can tag and comment on this same issue by tagging @sanjay-kv. We are here to help you on this journey of open source. Consistent 20 contributions are eligible for sponsorship 💰 🎁 check our list of amazing people we sponsored so far: GitHub Sponsorship. ✨ 📚Your perks for contribution to this community 👇🏻
If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊 |
|
@sanjay-kv pls have a look! |
|
@meetoza30 i forgot to tell you this branch have conflicts could you fix it |
There was a problem hiding this comment.
Pull Request Overview
This PR improves SQL documentation with comprehensive grammar fixes, clearer explanations, and consistent formatting. The changes focus on enhancing the learning experience for SQL beginners through better structure and technical accuracy.
- Grammar and spelling corrections throughout SQL documentation files
- Improved explanations of SQL concepts, IDE features, and setup instructions
- Updated Docusaurus dependencies to version 3.8.1 for consistency
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| package.json | Updates all Docusaurus dependencies to consistent version 3.8.1 |
| docs/sql/setup-environment.md | Enhances setup guide with clearer instructions, better IDE explanations, and grammar fixes |
| docs/sql/intro-sql.md | Corrects spelling errors, improves SQL concept explanations, and standardizes code formatting |
| -- Delete a record | ||
| DELETE FROM Students WHERE ID = 1; | ||
|
|
||
| text |
There was a problem hiding this comment.
The 'text' placeholder appears to be unintentional and should be removed or replaced with proper SQL syntax highlighting (```sql).
| text |
Copilot uses AI. Check for mistakes.
| -- After deleting the record: | ||
| (No rows returned) | ||
|
|
||
| text |
There was a problem hiding this comment.
The 'text' placeholder appears to be unintentional and should be removed or replaced with proper syntax highlighting (```plaintext).
| text |
Copilot uses AI. Check for mistakes.
|
|
||
| text | ||
| </TabItem> | ||
| <TabItem value="DML"> |
There was a problem hiding this comment.
The 'text' placeholder appears to be unintentional and should be removed or replaced with proper SQL syntax highlighting (```sql).
| text | |
| </TabItem> | |
| <TabItem value="DML"> |
Copilot uses AI. Check for mistakes.
| text | ||
| </TabItem> | ||
| <TabItem value="DCL"> | ||
| -- CREATE USER and GRANT statements (syntax may vary by DBMS) | ||
| CREATE USER 'new_user' IDENTIFIED BY 'password'; | ||
| GRANT SELECT, INSERT, UPDATE ON customers TO new_user; | ||
|
|
||
| text |
There was a problem hiding this comment.
The 'text' placeholder appears to be unintentional and should be removed or replaced with proper SQL syntax highlighting (```sql).
Copilot uses AI. Check for mistakes.
| CREATE USER 'new_user' IDENTIFIED BY 'password'; | ||
| GRANT SELECT, INSERT, UPDATE ON customers TO new_user; | ||
|
|
||
| text |
There was a problem hiding this comment.
The 'text' placeholder appears to be unintentional and should be removed or replaced with proper SQL syntax highlighting (```sql).
| text |
Copilot uses AI. Check for mistakes.
| -- ROLLBACK statement to undo changes made during a transaction | ||
| ROLLBACK; | ||
|
|
||
| text |
There was a problem hiding this comment.
The 'text' placeholder appears to be unintentional and should be removed or replaced with proper SQL syntax highlighting (```sql).
| text |
Copilot uses AI. Check for mistakes.
|
@sanjay-kv there were some docusaurus dependencies issue, ive resolved the conflict, pls have a look! |
Description
Improved SQL documentation with grammar fixes, clearer explanations, and consistent formatting. Enhanced the setup environment guide with step-by-step installation instructions, better IDE overview, and corrected technical details for a smoother learning experience.
Fixes #237
Type of Change
Changes Made
Spelling and Grammar Fixes: Corrected all mistakes (e.g., “Itegrated developement enviornment” → “Integrated Development Environment”).
Clarified Purpose: Explained why beginners should install MySQL Server and Workbench locally versus just using online tools.
Clear Installation Steps: Provided simplified, step-by-step instructions for downloading and installing MySQL Server and Workbench, with OS-specific links. IDE Explanation: Improved the explanation about what an IDE is, its key features, and why it’s useful for database work.
Professional Tone: Removed informal language and filler content; added relatable analogies in a concise manner. Expanded Features List: More clearly outlined important IDE functionalities such as syntax highlighting, database visualization, query execution, debugging, and performance monitoring.
Grammatical corrections throughout, including spelling ("Manupulation" → "Manipulation", "dont" → "don't", etc.).
Section/heading normalization for readability and visual clarity. Rewrote the history and limitations of Excel/Access and clarified DBMS adoption.
Clarified the difference between SQL/NoSQL databases and corrected technical inaccuracies. Corrected and defined "Schema" to match industry standards.
Fixed all references of "SAQl" to "SQL". Applied consistent inline code formatting (SELECT) to all keywords in explanations and examples.
Dependencies
Updated the dependencies related to docusaurus - to the latest version of 3.8.1
Checklist
npm run buildand attached scrrenshot in this PR.