Fix various docs #1077
Closed
Fix various docs #1077
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The previous version of the introduction article had an illogical flow for new learners, jumping between concepts without building a proper foundation. SEO elements were also minimal. This commit completely restructures the content to be more beginner-friendly and impactful: - Introduces the concept of Version Control first to establish the "why". - Clearly distinguishes between Git (the tool) and GitHub (the platform). - Improves SEO with a keyword-rich title, meta description, and tags. - Rewrites core concepts like 'Repository' and 'Pull Request' for better clarity. - Organizes the content with a logical heading structure.
The previous version of the introduction article had an illogical flow for new learners, jumping between concepts without building a proper foundation. SEO elements were also minimal. This commit completely restructures the content to be more beginner-friendly and impactful: - Introduces the concept of Version Control first to establish the "why". - Clearly distinguishes between Git (the tool) and GitHub (the platform). - Improves SEO with a keyword-rich title, meta description, and tags. - Rewrites core concepts like 'Repository' and 'Pull Request' for better clarity. - Organizes the content with a logical heading structure.
1.The entire meta block was commented out and has been fixed and enabled. 2.The og:url, og:image, and og:description tags were pointing to an incorrect article about the MERN stack. They now correctly point to the DeepMind article's assets and have an accurate, well-written description. 3.The primary description field was rewritten to be grammatically correct and more compelling.
Updated content to improve clarity and consistency throughout the article, including sections on energy efficiency, healthcare applications, and AI technology.
Fix: Proofread and Correct Metadata in DeepMind Article
1.Frontmatter and Naming Standardization: Consistent Naming: Standardized the program name to "Google Student Ambassador" throughout the article, removing confusion from variations like "Campus Ambassador" and "Gemini Ambassador." Synced Metadata: Updated the title, slug, and id in the frontmatter to be consistent with the main <h1> heading and article content. The new slug is /google-student-ambassador-program-2025. 2. Content and Factual Accuracy: Corrected Time Commitment: Resolved the contradiction in the FAQ. Both Q2 and Q3 now correctly state the time commitment as "5–7 hours per week." Removed Empty Section: Deleted the "Got Questions & What Happens Next?" section, as it contained no actionable information and detracted from the article's professional tone. 3.Accessibility and Code Quality: Added Alt Text: Provided descriptive alt text for both images, ensuring the article is accessible to screen readers. Removed Unused Import: Deleted an unused Layout component import to clean up the code.
1.Frontmatter and Naming Standardization: Consistent Naming: Standardized the program name to "Google Student Ambassador" throughout the article, removing confusion from variations like "Campus Ambassador" and "Gemini Ambassador." Synced Metadata: Updated the title, slug, and id in the frontmatter to be consistent with the main <h1> heading and article content. The new slug is /google-student-ambassador-program-2025. 2. Content and Factual Accuracy: Corrected Time Commitment: Resolved the contradiction in the FAQ. Both Q2 and Q3 now correctly state the time commitment as "5–7 hours per week." Removed Empty Section: Deleted the "Got Questions & What Happens Next?" section, as it contained no actionable information and detracted from the article's professional tone. 3. Accessibility and Code Quality: Added Alt Text: Provided descriptive alt text for both images, ensuring the article is accessible to screen readers. Removed Unused Import: Deleted an unused Layout component import to clean up the code.
1.Activated Social Media Metadata: The entire meta block containing Open Graph and Twitter card information was commented out. This has been uncommented, enabling rich previews when the article is shared on social platforms. 2.Added Canonical URL: Populated the empty canonical_url field to prevent duplicate content issues and improve search engine indexing. 3.Aligned Page Titles: The frontmatter title has been updated to match the on-page <h1> heading for better SEO alignment and user experience. The sidebar_label was also shortened for better UI fit. 4.Improved Image Accessibility: Enhanced the alt text for the architecture diagram to be more descriptive for users with screen readers.
1.The entire meta block containing Open Graph and Twitter card information was commented out. This has been uncommented, enabling rich previews when the article is shared on social platforms. 2.Populated the empty canonical_url field to prevent duplicate content issues and improve search engine indexing. 3.The frontmatter title has been updated to match the on-page <h1> heading for better SEO alignment and user experience. The sidebar_label was also shortened for better UI fit. 4.Enhanced the alt text for the architecture diagram to be more descriptive for users with screen readers.
This update refactors the sql-operators tutorial to improve technical accuracy, readability, and structural correctness. Key changes include: 1.Corrected "Operator Precedence" Example: The original examples in this section were flawed as they produced the same output, failing to demonstrate the risk of not using parentheses. This section has been rewritten with new queries that produce different results to clearly illustrate the concept. 2.Fixed LIKE Logic: Corrected the LIKE pattern matching example for "Alice" from ___ice% (3 underscores) to __ice% (2 underscores). 3.Added Missing Outputs: Provided the missing query outputs for the BETWEEN, IN, and corrected LIKE examples so users can see the result of every query. 4.Added Syntax Highlighting: Applied sql language highlighting to all code blocks for better readability. Fixed Semantic Headings: Changed main section headings from H4 (e.g., 📘) to H2 (##) for proper document structure. Standardized SQL Style: Converted all SQL data types (e.g., INT, VARCHAR) to UPPERCASE for consistency. Improved Clarity: Added a note that BETWEEN is inclusive and merged the redundant "Tips" and "Common Mistakes" sections.
1.Refactored All Examples: Replaced the multiple, fragmented CREATE TABLE statements with a single, unified students table example. This makes the tutorial more practical and easier to follow, as all common data types are shown working together. Standardized Code Blocks: Replaced all broken :::info blocks with proper sql syntax-highlighted code blocks and clean, separate Markdown tables for query outputs. Expanded Date/Time Section: Added the essential DATETIME and TIMESTAMP types, which were missing, and explained their common use cases (like the last_login example). Improved Numeric Guidance: Changed the gpa example from FLOAT to DECIMAL(3, 2) to teach the best practice for handling precise values (like grades or money) and strengthened the warning against using FLOAT. Integrated UNSIGNED Concept: Removed the separate, confusing UNSIGNED example and integrated the concept directly into the main students table by making the student_id an INT UNSIGNED. Cleaned Up Formatting: Consolidated the redundant tags and keywords in the frontmatter, added horizontal rules (---) between sections for readability, and standardized all SQL data types (e.g., INT, VARCHAR) to UPPERCASE for consistency.
This commit refines the "Spark Architecture Explained" blog post, addressing a major technical inaccuracy and cleaning up frontmatter metadata. Key changes: Fix (Memory Model): Rewrites the "Memory Management" section to accurately describe the modern Unified Memory Model used since Spark 1.6. This removes the outdated and incorrect description of the old static 60/20/20 memory split. 1.Fix (Frontmatter): Deletes the entire commented-out meta: block, which contained incorrect placeholder content about DeepMind and MERN stack. 2.Chore (Frontmatter): Removes the empty canonical_url key. 3.Style (Code): Adds the scala language specifier to code blocks to enable proper syntax highlighting. 4.Style (Accessibility): Improves the alt text for the architecture diagram for better accessibility.
docs(spark): Correct Spark memory model and fix post metadata
This commit applies several copy-edits to the "7 Steps to Streamline Your UX Design Process" article to improve readability, flow, and remove redundant content. Section 1 (Research): De-duplicated repetitive content and merged it into a single, stronger introductory section. Section 4 (Refine): Deleted a misplaced sentence about prototypes that belonged in the next step. Section 6 (Feedback): Removed a weak introductory paragraph to make the section more direct. Section 7 (Launch): Streamlined the content by removing generic opening paragraphs and a redundant concluding paragraph that was already covered in the "Takeaway" section. Footer: Fixed a typo (a stray "f") in the contact email address. Frontmatter: Removed a non-standard space before the truncate comment.
Here is a commit message and description for the changes you made. Subject: docs(ux): Refine and streamline UX design process article Description: This commit applies several copy-edits to the "7 Steps to Streamline Your UX Design Process" article to improve readability, flow, and remove redundant content. Section 1 (Research): De-duplicated repetitive content and merged it into a single, stronger introductory section. Section 4 (Refine): Deleted a misplaced sentence about prototypes that belonged in the next step. Section 6 (Feedback): Removed a weak introductory paragraph to make the section more direct. Section 7 (Launch): Streamlined the content by removing generic opening paragraphs and a redundant concluding paragraph that was already covered in the "Takeaway" section. Footer: Fixed a typo (a stray "f") in the contact email address. Frontmatter: Removed a non-standard space before the truncate comment.
1.Fix (Frontmatter): Corrected a spelling error in the tags (from "Desgin" to "Design"). 2.Fix (Frontmatter): Replaced the placeholder "Google DeepMind" description with a summary that is relevant to the article's content. 3.Chore (Frontmatter): Deleted the entire commented-out meta: block, as it was placeholder content from a template. 4.Chore (Frontmatter): Removed the empty canonical_url key. 5.Refactor (Content): Removed multiple repetitive paragraphs and sections. The same core points about AI's role, the challenges for designers, and the importance of human-centricity were repeated in the intro, a dedicated section, and the conclusion. These have been consolidated for a more concise and impactful article. 6.Chore (Formatting): Removed a stray em-space before the `` comment and an empty bullet point.
1.Fix (Frontmatter): Corrected a spelling error in the tags (from "Desgin" to "Design"). 2.Fix (Frontmatter): Replaced the placeholder "Google DeepMind" description with a summary that is relevant to the article's content. 3.Chore (Frontmatter): Deleted the entire commented-out meta: block, as it was placeholder content from a template. 4.Chore (Frontmatter): Removed the empty canonical_url key. 5.Refactor (Content): Removed multiple repetitive paragraphs and sections. The same core points about AI's role, the challenges for designers, and the importance of human-centricity were repeated in the intro, a dedicated section, and the conclusion. These have been consolidated for a more concise and impactful article. 6.Chore (Formatting): Removed a stray em-space before the `` comment and an empty bullet point.
This commit provides a major cleanup and refactoring of the "10 Steps to Land a Job in UI/UX Design" article. The changes address metadata errors, structural issues, and significant content redundancy. 1.Metadata Fixes: Corrected a spelling error in the tags (Desgin -> Design), replaced an irrelevant AI tag, and removed placeholder/empty keys (meta, canonical_url). 2.Structural Improvements: Moved the main article introduction to the top (it was incorrectly placed within the first step) and added numbering to the 10 step headings for better clarity. 3.Content Refactoring: Removed repetitive concluding paragraphs from nearly every step. This makes the article much more concise and easier to read. 4.Content Correction: Fixed incorrect step numbers mentioned within the text and replaced the "Final Verdict" section's content, which was a copy-paste error from a different article.
This commit provides a major cleanup and refactoring of the "10 Steps to Land a Job in UI/UX Design" article. The changes address metadata errors, structural issues, and significant content redundancy. Metadata Fixes: Corrected a spelling error in the tags (Desgin -> Design), replaced an irrelevant AI tag, and removed placeholder/empty keys (meta, canonical_url). Structural Improvements: Moved the main article introduction to the top (it was incorrectly placed within the first step) and added numbering to the 10 step headings for better clarity. Content Refactoring: Removed repetitive concluding paragraphs from nearly every step. This makes the article much more concise and easier to read. Content Correction: Fixed incorrect step numbers mentioned within the text and replaced the "Final Verdict" section's content, which was a copy-paste error from a different article.
changes made to the document: * Corrected the document title and sidebar_label from "Introduction of GitHub" to "Introduction to GitHub" for grammatical accuracy. * Rewrote the "Key Features" section to remove factually incorrect information (e.g., "Premium" plan, "Repo time") and replaced it with accurate features like collaboration tools and GitHub Actions. * Corrected the attribution for Git's creation to "Linus Torvalds," removing the incorrect "and Junior." * Fixed multiple technical inaccuracies in the terminology tables, clarifying the definitions for Branch, Fork, Hash, and Repo, and filled in a missing description for Remote. * Repaired the broken Markdown syntax for both tables, allowing them to render correctly. * Removed a broken, irrelevant hyperlink (to Visual Studio Code) that was wrapped around an image. * Replaced the non-functional placeholder URL in the YouTube iframe with a valid one. * Fixed numerous typographical errors (e.g., "repeitive") and grammatical mistakes (e.g., "it let's people," "want we do"). * Removed the redundant, repeated sentence in the "Conclusion" section.
description of the changes made: * Refined Tags: Cleaned up the frontmatter tags to be specific to Python arrays, removing irrelevant general topics like "Variables" and "Operators." * Added Description: Inserted a description field into the frontmatter for better SEO and document summary. * Clarified Code Example: Updated the "Membership Test" code block to use values that are actually in the example array and showed the real True/False outputs. * Improved Copying Method: Changed the "Copying Arrays" example to use the simpler, more common slicing method (a[:]) instead of the verbose constructor method. * Fixed Formatting: Corrected a minor Markdown formatting error in the "Practice Questions" section.
Update python-array.md
description of the changes: * Cleaned the tags in the frontmatter, removing overly general topics and keeping only relevant keywords. * Added a description field to the frontmatter for better document metadata. * Removed the redundant "Specify a Variable Type" section, as it duplicated the int() section. * Corrected the heading levels for int(), float(), and str() from ### (H3) to ## (H2) for proper document structure. * Added a note clarifying that int() truncates (does not round) floats. * Expanded the "Summary Table" with more examples to show type-to-type conversions (like int() to float()).
Update python-casting.md
descriptions based on the changes: * fix(docs): Correct Python dictionary definition and tags * docs: Update dictionary definition (ordered) and clean up frontmatter * refactor(docs): Improve dictionary definition and remove irrelevant tags
Update python-dictionaries.md
|
@DIYA-bot 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! 😊 |
github-actions
bot
added
hacktoberfest-accepted
recode
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
| @@ -1,192 +1,121 @@ | |||
|
|
|||
There was a problem hiding this comment.
The file has multiple blank lines before the frontmatter delimiter, and the frontmatter structure is incomplete. The frontmatter should start immediately without blank lines and follow proper YAML syntax.
View Details
📝 Patch Details
diff --git a/docs/sql/SQL-basics/datatypes.md b/docs/sql/SQL-basics/datatypes.md
index d371913..c44a2f1 100644
--- a/docs/sql/SQL-basics/datatypes.md
+++ b/docs/sql/SQL-basics/datatypes.md
@@ -1,6 +1,3 @@
-
-
-
---
id: sql-datatypes
title: SQL Data Types
@@ -35,11 +32,11 @@ Data types are super important because they:
Imagine a `students` table. Data types ensure the `student_id` is a number, `first_name` is text, and `enrollment_date` is a date.
-Here’s a handy overview to get you started:
+Here's a handy overview to get you started:
:::tip Pro Tip
-Always pick the smallest, most appropriate data type for your data. For example, don’t use a text type for numbers you want to do math on!
+Always pick the smallest, most appropriate data type for your data. For example, don't use a text type for numbers you want to do math on!
:::
---
@@ -112,7 +109,7 @@ In our students table, we used INT UNSIGNED for student_id. This is perfect beca
Use UNSIGNED for any number column that can never be negative (like an ID, age, or stock quantity).
:::
✅ What You've Learned
-Great job! You’ve explored the most important SQL data types:
+Great job! You've explored the most important SQL data types:
Numeric Types: INT, DECIMAL (for precision), and FLOAT.
String Types: CHAR (fixed) vs. VARCHAR (variable).
Date/Time Types: DATE, DATETIME, and TIMESTAMP.
Analysis
Frontmatter parsing failure due to leading blank lines in docs/sql/SQL-basics/datatypes.md
What fails: gray-matter library (used by Docusaurus) ignores YAML frontmatter when the --- delimiter has leading blank lines
How to reproduce:
# Test frontmatter parsing with leading blank lines
node -e "
const matter = require('gray-matter');
const fs = require('fs');
const content = fs.readFileSync('docs/sql/SQL-basics/datatypes.md', 'utf8');
console.log('Parsed fields:', Object.keys(matter(content).data).length);
"Result: Returns Parsed fields: 0 - frontmatter completely ignored, treated as document content
Expected: Should parse 6 frontmatter fields (id, title, sidebar_label, sidebar_position, tags, description) per Zettlr YAML frontmatter docs - frontmatter delimiter must start on line 1
Fix: Removed 3 leading blank lines before --- delimiter to comply with YAML frontmatter specification
| tags: | ||
| [ | ||
| GitHub, | ||
| GitHub,git,version control |
There was a problem hiding this comment.
The YAML frontmatter has a malformed tags array with missing commas and no closing --- delimiter, which will cause parsing errors and prevent the document from being properly recognized by the documentation system.
View Details
📝 Patch Details
diff --git a/docs/Technical/intro-github.md b/docs/Technical/intro-github.md
index c341e97..8cf38fc 100644
--- a/docs/Technical/intro-github.md
+++ b/docs/Technical/intro-github.md
@@ -4,14 +4,17 @@ title: Getting Started with GitHub in 2025
sidebar_label: Introduction of GitHub #displays in sidebar
sidebar_position: 1
tags:
- [
- GitHub,git,version control
- Introduction of GitHub,
- What is GitHub, open source
- Why learn GitHub,beginner guide
- How to use GitHub,
- ]
+ - GitHub
+ - git
+ - version control
+ - Introduction of GitHub
+ - What is GitHub
+ - open source
+ - Why learn GitHub
+ - beginner guide
+ - How to use GitHub
description: New to GitHub? This beginner's guide explains what Git and GitHub are, why they're essential for developers, and how to start your open-source journey. Learn key concepts like repositories, commits, and pull requests.
+---
GitHub is a web-based platform used for version control and collaboration. It allows developers to work together on projects from anywhere in the world. GitHub is built on top of Git, a distributed version control system created by Linus Torvalds in 2005.
Analysis
YAML frontmatter parsing error in docs/Technical/intro-github.md breaks Docusaurus build
What fails: Docusaurus build fails with YAMLException when processing docs/Technical/intro-github.md due to malformed tags array and missing closing frontmatter delimiter
How to reproduce:
npm run buildResult: Build fails with error "YAMLException: can not read a block mapping entry; a multiline key may not be an implicit key at line 19, column 23"
Expected: Docusaurus should build successfully with properly parsed YAML frontmatter per YAML specification and Docusaurus frontmatter requirements
Root cause:
- Tags array uses invalid mixed syntax with missing commas between array elements
- Missing closing
---delimiter for frontmatter section
Comment on lines
+1
to
+3
|
|
||
|
|
||
| - --- |
There was a problem hiding this comment.
The YAML frontmatter has invalid syntax with - --- on line 3, which will cause the document parser to fail. This should be just --- to open the frontmatter properly.
View Details
📝 Patch Details
diff --git a/docs/sql/SQL-basics/Operators.md b/docs/sql/SQL-basics/Operators.md
index 50fd12f..a886f9b 100644
--- a/docs/sql/SQL-basics/Operators.md
+++ b/docs/sql/SQL-basics/Operators.md
@@ -1,6 +1,4 @@
-
-
-- ---
+---
id: sql-operators
title: SQL Operators
sidebar_label: SQL Operators
@@ -66,4 +64,4 @@ INSERT INTO products VALUES (1, 15.99, 10), (2, 25.50, 5);
SELECT id, price, quantity,
price * quantity AS total_value,
price + 2.00 AS price_with_tax
-FROM products;
+FROM products;
\ No newline at end of file
Analysis
YAML frontmatter syntax error in docs/sql/SQL-basics/Operators.md breaks metadata parsing
What fails: gray-matter parser (used by Docusaurus) cannot parse frontmatter with - --- syntax, returning empty metadata object instead of expected document properties
How to reproduce:
const matter = require('gray-matter');
const content = fs.readFileSync('docs/sql/SQL-basics/Operators.md', 'utf8');
const parsed = matter(content);
// Result: parsed.data = {} instead of {id: 'sql-operators', title: 'SQL Operators', ...}Result: Document metadata (id, title, sidebar_label, sidebar_position, tags, description) not parsed, causing missing navigation entries and broken page metadata
Expected: Frontmatter should start with exactly --- per Jekyll and Hugo specifications - Docusaurus follows same standard
|
i suggest one doc at a time. it fails |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes # (issue)
Type of Change
Changes Made
Dependencies
Checklist
npm run buildand attached screenshot(s) in this PR.