-
Notifications
You must be signed in to change notification settings - Fork 132
Fixes#1018: Improved markdown and code snippets in Fun Profile Customization #1031
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
Conversation
|
@steam-bell-92 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! 😊 |
|
✅ Synchronized metadata from Issue #1018:
|
| Once your profile repo is set up, customization offers tangible benefits that go far beyond aesthetics: | ||
|
|
||
| 1. **First Impressions and Engagement:** A creative, customized profile is immediately **engaging and memorable**, encouraging visitors (mentors, recruiters, or collaborators) to spend more time exploring your work. By highlighting your key skills and active projects upfront, you dramatically increase the chances of a meaningful connection. | ||
| - 1. **First Impressions and Engagement:** A creative, customized profile is immediately **engaging and memorable**, encouraging visitors (mentors, recruiters, or collaborators) to spend more time exploring your work. By highlighting your key skills and active projects upfront, you dramatically increase the chances of a meaningful connection. |
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.
The numbered list formatting is incorrect, mixing bullet point syntax with numbering (- 1., - 2., etc.) instead of standard markdown numbered list format.
View Details
📝 Patch Details
diff --git a/docs/GitHub/Fun-Profile-Customizations/Why-Customize.md b/docs/GitHub/Fun-Profile-Customizations/Why-Customize.md
index 47962cd..fd96552 100644
--- a/docs/GitHub/Fun-Profile-Customizations/Why-Customize.md
+++ b/docs/GitHub/Fun-Profile-Customizations/Why-Customize.md
@@ -16,10 +16,10 @@ Before you can add any dynamic stats or flair, you must complete the single, mos
Once your profile repo is set up, customization offers tangible benefits that go far beyond aesthetics:
-- 1. **First Impressions and Engagement:** A creative, customized profile is immediately **engaging and memorable**, encouraging visitors (mentors, recruiters, or collaborators) to spend more time exploring your work. By highlighting your key skills and active projects upfront, you dramatically increase the chances of a meaningful connection.
+1. **First Impressions and Engagement:** A creative, customized profile is immediately **engaging and memorable**, encouraging visitors (mentors, recruiters, or collaborators) to spend more time exploring your work. By highlighting your key skills and active projects upfront, you dramatically increase the chances of a meaningful connection.
-- 2. **Highlight Activity and Commitment:** Dynamic cards displaying stats for your **total commits, contribution streaks, and top languages** automatically validate your commitment to continuous learning and development. This proof-of-work is far more convincing than a simple claim on a resume.
+2. **Highlight Activity and Commitment:** Dynamic cards displaying stats for your **total commits, contribution streaks, and top languages** automatically validate your commitment to continuous learning and development. This proof-of-work is far more convincing than a simple claim on a resume.
-- 3. **Showcase Your Identity and Skills:** Customization allows you to highlight projects that matter most to you, whether it's a specific Recode Hive project or a new language you're mastering. Your profile becomes a curated **showcase of your specific expertise** and personality.
+3. **Showcase Your Identity and Skills:** Customization allows you to highlight projects that matter most to you, whether it's a specific Recode Hive project or a new language you're mastering. Your profile becomes a curated **showcase of your specific expertise** and personality.
-- 4. **Professional Polish and Detail:** A well-structured, customized profile demonstrates **attention to detail, technical flair, and ownership**. These soft skills are highly valued in any professional development setting.
\ No newline at end of file
+4. **Professional Polish and Detail:** A well-structured, customized profile demonstrates **attention to detail, technical flair, and ownership**. These soft skills are highly valued in any professional development setting.
\ No newline at end of file
diff --git a/docs/GitHub/GitHub-basics/create-github-repo.md b/docs/GitHub/GitHub-basics/create-github-repo.md
index 38065fc..a53c8b6 100644
--- a/docs/GitHub/GitHub-basics/create-github-repo.md
+++ b/docs/GitHub/GitHub-basics/create-github-repo.md
@@ -12,8 +12,8 @@ To create and host a project, the repository is a place where you add all your p
### Prerequisites
-- 1. You must have a GitHub account.
-- 2. You must also have a basic understanding of how Git works and ensure Git is installed and running on your operating system.
+1. You must have a GitHub account.
+2. You must also have a basic understanding of how Git works and ensure Git is installed and running on your operating system.
### How to create Github Repository
diff --git a/docs/GitHub/Maintainer-guide/enable-discussion.md b/docs/GitHub/Maintainer-guide/enable-discussion.md
index ee03702..e2366a8 100644
--- a/docs/GitHub/Maintainer-guide/enable-discussion.md
+++ b/docs/GitHub/Maintainer-guide/enable-discussion.md
@@ -12,8 +12,8 @@ In order to create a project and host, the repository is a place where you add a
### Prerequisites
-- 1. You must have a GitHub account.
-- 2. You must also have a basic understanding of how Git works and ensure Git is installed and running on your operating system.
+1. You must have a GitHub account.
+2. You must also have a basic understanding of how Git works and ensure Git is installed and running on your operating system.
### How to create GitHub Repository
diff --git a/docs/GitHub/Maintainer-guide/github-labels.md b/docs/GitHub/Maintainer-guide/github-labels.md
index 62dc98e..6271711 100644
--- a/docs/GitHub/Maintainer-guide/github-labels.md
+++ b/docs/GitHub/Maintainer-guide/github-labels.md
@@ -12,8 +12,8 @@ Inorder to create a project and host, the repository is a place where you add al
### Prerequisites
-- 1. You should have a Github account
-- 2. Should have a basic understanding of how Git works/ and Git running in your OS.
+1. You should have a Github account
+2. Should have a basic understanding of how Git works/ and Git running in your OS.
### How to create Github Repository
diff --git a/docs/GitHub/Maintainer-guide/github-project.md b/docs/GitHub/Maintainer-guide/github-project.md
index 5841bc5..d15c5d1 100644
--- a/docs/GitHub/Maintainer-guide/github-project.md
+++ b/docs/GitHub/Maintainer-guide/github-project.md
@@ -12,8 +12,8 @@ Inorder to create a project and host, the repository is a place where you add al
### Prerequisites
-- 1. You should have a Github account
-- 2. Should have a basic understanding of how Git works/ and Git running in your OS.
+1. You should have a Github account
+2. Should have a basic understanding of how Git works/ and Git running in your OS.
### How to create Github Repository
diff --git a/docs/GitHub/Maintainer-guide/milestone.md b/docs/GitHub/Maintainer-guide/milestone.md
index 86d5975..283a1c5 100644
--- a/docs/GitHub/Maintainer-guide/milestone.md
+++ b/docs/GitHub/Maintainer-guide/milestone.md
@@ -12,8 +12,8 @@ Inorder to create a project and host, the repository is a place where you add al
### Prerequisites
-- 1. You should have a Github account
-- 2. Should have a basic understanding of how Git works/ and Git running in your OS.
+1. You should have a Github account
+2. Should have a basic understanding of how Git works/ and Git running in your OS.
### How to create Github Repository
Analysis
Incorrect numbered list formatting in multiple markdown files
What fails: Numbered lists in 6 documentation files use incorrect - 1. format (mixing bullet point and numbering syntax) instead of standard markdown 1. format
How to reproduce:
- Check markdown files:
docs/GitHub/Fun-Profile-Customizations/Why-Customize.mdlines 19-25 - View other affected files:
docs/GitHub/GitHub-basics/create-github-repo.md,docs/GitHub/Maintainer-guide/enable-discussion.md, etc. - Compare with proper numbered lists used elsewhere in the same repository
Result: Lists render as bullet points containing numbered text instead of proper ordered lists. Format - 1. creates unordered list items, not numbered sequences.
Expected: Standard markdown numbered lists using 1., 2., 3. format per GitHub's markdown documentation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Description
docs/GitHub/Fun Profile Customization/...with proper markdown start & end.Fixes 📝[Docs]: Updating docs/GitHub/Fun GitHub Profile Customization/.. #1018
Type of Change
Changes Made
Rearranged markdown and code snippets as shown in issue attachments.
Checklist
npm run buildand attached screenshot(s) in this PR.docker run -p 3000:3000 recodehive-appand attached ss in the same issue itself