feat: update project documentation with SEO keywords (open-sauced#237)

* docs(seo): update project documentation with SEO keywords. * docs(seo): update project documentation with SEO keywords. * docs(seo): update project documentation with SEO keywords.
Lymah123 · Jan 26, 2024 · 664cc7f · 664cc7f
1 parent a7b4fea
commit 664cc7f
Show file tree

Hide file tree

Showing 35 changed files with 271 additions and 4 deletions.
diff --git a/docs/community/100-days-of-oss.md b/docs/community/100-days-of-oss.md
@@ -4,6 +4,12 @@ title: "#100DaysOfOSS: Growing Skills and Real-World Experience"
 sidebar_label: "#100DaysOfOSS"
 keywords:
   - "100 days of open source"
+  - "100 days of OSS"
+  - "Open source contribution"
+  - "Open source software development"
+  - "Open source projects for beginners"
+  - "Open source development"
+
 ---
 
 Inspired by the great work of the [#100DaysOfCode challenge](https://www.100daysofcode.com/), we're starting #100DaysOfOSS.

diff --git a/docs/community/hacktoberfest.md b/docs/community/hacktoberfest.md
@@ -4,6 +4,11 @@ title: "Join us for Hacktoberfest! 🎃"
 sidebar_label: "Join us for Hacktoberfest! 🎃"
 keywords:
   - "hacktoberfest"
+  - "Open source contributions for Hacktoberfest"
+  - "Hacktoberfest participation guide"
+  - "Open source collaboration in October"
+  - "Hacktoberfest beginner-friendly projects"
+  - "How to get involved in Hacktoberfest"
 ---
 
 At OpenSauced, we love open source just as much as pizza! That's why we are participating in Hacktoberfest! 🎃

diff --git a/docs/community/welcome-to-the-community.md b/docs/community/welcome-to-the-community.md
@@ -4,6 +4,10 @@ title: "Welcome to the OpenSauced Community"
 sidebar_label: "Welcome to the Community"
 keywords:
   - "welcome to the community"
+  - "The community welcomes you"
+  - "Get involved in the community"
+  - "Join our community"
+  - "Greetings from the community"
 ---
 
 Welcome to the OpenSauced community! At OpenSauced, we strive to bring collaboration and inspiration to every open source contributor and help build a global community of open source developers, empowering you to grow, innovate, and achieve greatness in the open.

diff --git a/docs/contributing/code-of-conduct.md b/docs/contributing/code-of-conduct.md
@@ -4,6 +4,11 @@ title: "Code of Conduct"
 sidebar_label: "Code of Conduct"
 keywords:
   - "code of conduct"
+  - "Community guidelines"
+  - "Guidelines for behavior"
+  - "Interaction guidelines"
+  - "rules and guidelines"
+  - "Behavioral expectations"
 ---
 
 ## Our Pledge

diff --git a/docs/contributing/introduction-to-contributing.md b/docs/contributing/introduction-to-contributing.md
@@ -4,6 +4,16 @@ title: "Introduction to Contributing"
 sidebar_label: "Introduction to Contributing"
 keywords:
   - "introduction to contributing"
+  - "Getting started with contributions"
+  - "New contributor guide"
+  - "How to contribute effectively"
+  - "Contribution essentials"
+  - "Open source contribution guide"
+  - "Making your first contribution"
+  - "Beginner-friendly contributions"
+  - "Contributing to open source projects"
+  - "Starting your contribution journey"
+  -  "First-time contributor tips"
 ---
 
 Contributions are always welcome, no matter how large or small. Before contributing,

diff --git a/docs/contributing/maintainers-guide.md b/docs/contributing/maintainers-guide.md
@@ -4,6 +4,10 @@ title: "OpenSauced Maintainers Guide"
 sidebar_label: "OpenSauced Maintainers Guide"
 keywords:
   - "maintainers guide"
+  - "open source maintainers guide" 
+  - "open source maintainer"
+  - "open-source project management"
+  - "community management in open-source" 
 ---
 
 Welcome to the OpenSauced Maintainers Guide for contributors who are interested in being part of the maintainer team for OpenSauced repositories.

diff --git a/docs/contributing/set-up-authentication.md b/docs/contributing/set-up-authentication.md
@@ -4,6 +4,15 @@ title: "Set Up Authentication"
 sidebar_label: "Set Up Authentication"
 keywords:
   - "set up authentication"
+  - "Authentication setup guide"
+  - "Setting up secure login"
+  - "User authentication configuration"
+  - "Authentication system setup"
+  - "Authentication implementation steps"
+  - "Authentication setup tutorial"
+  - "Setting up user authorization"
+  - "Step-by-step authentication setup"
+  - "Authentication best practices"
 ---
 
 You need to obtain an authentication token to interact with the OpenSauced public API as an authenticated user.

diff --git a/docs/contributing/technical/resolve-merge-conflicts.md b/docs/contributing/technical/resolve-merge-conflicts.md
@@ -4,6 +4,19 @@ title: "Resolve Merge Conflicts"
 sidebar_label: "Resolve Merge Conflicts"
 keywords:
   - "resolve merge conflicts"
+  - "merge-conflict"
+  - "solve merge conflicts"
+  - "Git merge conflict"
+  - "Merge conflict resolution"
+  - "Merge conflict prevention"
+  - "Merge conflict handling"
+  - "Merge conflict management"
+  - "Merge conflict avoidance"
+  - "Merge conflict workflow"
+  - "Merge conflict strategies"
+  - "Merge conflict best practices"
+  - "Merge conflict tools"
+
 ---
 
 When you are working on any of the OpenSauced repositories, you might run into a merge conflict. A merge conflict occurs when multiple conflicting changes are made to the same line in a file. Merge conflicts happen the most when you open a pull request, as the release process generally updates `npm-shrinkwrap.json`.

diff --git a/docs/contributing/technical/setup-repo-with-git.md b/docs/contributing/technical/setup-repo-with-git.md
@@ -4,8 +4,18 @@ title: "Setting Up a Repository with Git and GitHub"
 sidebar_label: "Setting Up a Repository with Git and GitHub"
 keywords:
   - "setting up a repository with Git and GitHub"
+  - "working with git and github"
+  - "GitHub repository creation"
+  - "GitHub repository workflow"
+  - "GitHub repository initialization"
+  - "GitHub repository hosting"
+  - "GitHub repository collaboration"
+  - "GitHub repository version control"
+  - "GitHub repository deployment"
+  - "GitHub repository setup"  
 ---
 
+
 ## Using the GitHub CLI
 
 ### How to Install the GitHub CLI

diff --git a/docs/contributing/triage-guide.md b/docs/contributing/triage-guide.md
@@ -4,6 +4,16 @@ title: "Triage Guide"
 sidebar_label: "Triage Guide"
 keywords:
   - "triage guide"
+  - "Issue triage best practices"
+  - "GitHub triage process"
+  - "Pull request triage steps"
+  - "Triage workflow tutorial"
+  - "Effective issue management"
+  - "Open source contribution triage"
+  - "Triage for project maintainers"
+  - "Streamlining triage efforts"
+  - "Collaborative issue handling"
+  - "Contributor triage assistance"
 ---
 
 ## How to Join the Triage Team

diff --git a/docs/features/connections.md b/docs/features/connections.md
@@ -4,6 +4,16 @@ title: "Grow Your Network with Our Connections Feature!"
 sidebar_label: "Connections"
 keywords:
   - "connections"
+  - "Network connections"
+  - "Professional connections"
+  - "Building connections"
+  - "Online connections"
+  - "Networking opportunities"
+  - "tech connections"
+  - "grow newtwork"
+  - "grow connection"
+  - "Community connections"
+
 ---
 
 ## What are Connections?

diff --git a/docs/features/dev-card.md b/docs/features/dev-card.md
@@ -4,6 +4,13 @@ title: "Showcase Your Open Source Stats with Your Dev Card"
 sidebar_label: "Dev Card"
 keywords:
   - "dev card"
+  - "DevCard"
+  - "OpenSource"
+  - "Open Source DevCard"
+  - "Showcase DevCard"
+  - "Showcase Your Open Source Stats"
+  - "Open Source Stats DevCard"
+
 ---
 
 The Dev Card feature is what we like to call your "open source business card."

diff --git a/docs/features/highlights.md b/docs/features/highlights.md
@@ -3,7 +3,11 @@ id: highlights
 title: "Highlight Your Open Source Contributions"
 sidebar_label: "Highlights"
 keywords:
-  - "highlights"
+  - "Highlights"
+  - "Open Source Highlights"
+  - "Contribution Highlights"
+  - "Highlight your open source contributiions"
+  - "Open Source Contribution Highlights"
 ---
 
 The Highlights feature is the place you can display your favorite open source contributions, share the story, and inspire others to join you in your open source journey. For maintainers, it's a great way to showcase your project and the issues that need support and attract new contributors.

diff --git a/docs/features/insights.md b/docs/features/insights.md
@@ -4,6 +4,12 @@ title: "Insights into Open Source Projects"
 sidebar_label: "Insights"
 keywords:
   - "insights"
+  - "open source"
+  - "projects"
+  - "Open Source Insights" 
+  - "Project Insights"
+  - "Insights into Open Source Projects"
+  - "Open Source Project Insights"
 ---
 
 The Insights feature is your one-stop solution for understanding the pulse of your open-source projects and contributions. This feature is designed to provide a comprehensive view of your project's health and your individual contributions. From contribution trends to community health, OpenSauced Insights helps you make data-driven decisions that align with your goals. It's not just about numbers; it's about providing data to help you make decisions that can define your approach to open source and tell the story of your project or contribution journey.

diff --git a/docs/features/lists.md b/docs/features/lists.md
@@ -4,6 +4,11 @@ title: "Organize and Monitor Your Contributors"
 sidebar_label: "Lists"
 keywords:
   - "lists"
+  - "contributors"
+  - "organize"
+  - "Monitor Contributors"
+  - "Organize Contributors"
+  - "Contributor Lists Management"
 ---
 
 The Lists feature enables you to categorize, monitor, and analyze different groups of contributors within open source projects. With the Lists feature, gain granular insights into each contributor's activity and contributions.

diff --git a/docs/introduction.md b/docs/introduction.md
@@ -4,6 +4,9 @@ title: "Introduction to OpenSauced 🍕"
 sidebar_label: "Introduction to OpenSauced 🍕"
 keywords:
   - "introduction"
+  - "introduction to opensauced"
+  - "opensauced introduction"
+  - "get to know opensauced"
 ---
 
 ![Example banner](../static/img/what-is-opensauced-borderless.jpg)

diff --git a/docs/job-seekers-guide/categorize-contributions.md b/docs/job-seekers-guide/categorize-contributions.md
@@ -3,7 +3,15 @@ id: how-to-translate-open-source-contributions-into-career-opportunities
 title: "How to Translate Open Source Contributions into Career Opportunities"
 sidebar_label: "How to Translate Open Source Contributions into Career Opportunities"
 keywords:
-  - how-to-translate-open-source-contributions-into-career-opportunities
+  - "how-to-translate-open-source-contributions-into-career-opportunities"
+  - "how to get a job with open source contributions"
+  - "benefits of open source contributions for career development"
+  - "open source projects to boost your resume"
+  - "how to showcase your open source work to employers"
+  - "open source skills that employers look for"
+  - "how to find open source opportunities in your field"
+  - "best practices for open source contributors"
+  - "open source success stories and tips"
 ---
 
 It is important to keep track of your open source contributions and show the impact you have left on the projects and organizations. By organizing your work, you will be able to talk about these meaningful contributions on your resume and in job interviews.

diff --git a/docs/job-seekers-guide/introduction.md b/docs/job-seekers-guide/introduction.md
@@ -3,7 +3,14 @@ id: job-seekers-guide-introduction
 title: "Learn How to Land a Tech Job Using OpenSauced"
 sidebar_label: "Introduction"
 keywords:
-  - job-seekers-guide-introduction
+  - "job-seekers-guide-introduction"
+  - "open source tech job guide"
+  - "open sauced tech job tips"
+  - "open source career development"
+  - "open source projects for tech resume"
+  - "open source skills for tech employers"
+  - "land your dream tech job"
+open sauced:
 ---
 
 When you are looking for a tech job, it is important to stand out amongst the sea of candidates. One great way to stand out and showcase your skills is through Open Source contributions.

diff --git a/docs/maintainers/maintainers-guide.md b/docs/maintainers/maintainers-guide.md
@@ -5,6 +5,11 @@ sidebar_label: "Maintainers Guide to OpenSauced"
 keywords:
   - "maintainers"
   - "guides"
+  - "open source maintainers guide" 
+  - "open source maintainer"
+  - "open-source project management"
+  - "community management in open-source" 
+  - "Maintainers Guide to OpenSauced"
 ---
 
 ## Introduction to OpenSauced for Maintainers

diff --git a/docs/maintainers/understanding-insights.md b/docs/maintainers/understanding-insights.md
@@ -5,6 +5,15 @@ sidebar_label: "Understanding Insights Data"
 keywords:
   - "maintainers"
   - "guides"
+  - "Insights Interpretation"
+  - "Analytical Understanding"
+  - "Insights Overview"
+  - "Maintainer Insights"
+  - "Guide to Data Understanding"
+  - "Data Interpretation Methods"
+  - "Insightful Data Examination"
+  - "Guide to Understanding Data"
+
 ---
 
 Once your repositories are connected, it's time to understand the data provided in your Insight Page. Understanding this data is key to effectively managing your projects and contributors.

diff --git a/docs/maintainers/understanding-lists-data.md b/docs/maintainers/understanding-lists-data.md
@@ -5,6 +5,16 @@ sidebar_label: "Understanding Lists Data"
 keywords:
   - "maintainers"
   - "guides"
+  - "Lists Analysis"
+  - "List Data Exploration"
+  - "Data Organization"
+  - "Data Insight from Lists"
+  - "List Visualization"
+  - "Data Representation in Lists
+  - "List-Based Insights"
+  - "List Data Interpretation"
+  - "Organizing Data in Lists"
+  - "List-Based Analytics"
 ---
 
 Once you've created your list of contributors, it's time to understand the data provided. Understanding this data is key to effectively managing your projects and contributors.

diff --git a/docs/opensauced-packages/check-engines.md b/docs/opensauced-packages/check-engines.md
@@ -4,6 +4,12 @@ title: "@open-sauced/check-engines"
 sidebar_label: "@open-sauced/check-engines"
 keywords:
   - "@open-sauced/check-engines"
+  - "open sauced check engines"
+  - "npm install check engines"
+  - "open source dependency verification"
+  - "npm package engines property"
+  - "open sauced dependency management"
+  - "npm run check engines"
 ---
 
 ## Description

diff --git a/docs/opensauced-packages/conventional-commit.md b/docs/opensauced-packages/conventional-commit.md
@@ -4,6 +4,18 @@ title: "@open-sauced/conventional-commit"
 sidebar_label: "@open-sauced/conventional-commit"
 keywords:
   - "@open-sauced/conventional-commit"
+  - "commitizen conventional commit"
+  - "open source commit standards"
+  - "how to use @open-sauced/conventional-commit"
+  - "npm package for conventional commit"
+  - "open sauced commit guide"
+  - "conventional commit best practices"
+  - "Commit Message Standards"
+  - "Semantic Versioning"
+  - "Git Commit Conventions"
+  - "Standardized Commit Messages"
+  - "Version Control Best Practices"
+
 ---
 
 ## Description

diff --git a/docs/opensauced-packages/semantic-release.md b/docs/opensauced-packages/semantic-release.md
@@ -4,6 +4,12 @@ title: "@open-sauced/semantic-release-conventional-config"
 sidebar_label: "@open-sauced/semantic-release-conventional-config"
 keywords:
   - "@open-sauced/semantic-release-conventional-config"
+  - "semantic release conventional config"
+  - "open sauced semantic release"
+  - "npm package for semantic release"
+  - "semantic release best practices"
+  - "semantic release shareable config"
+  - "semantic release plugins and presets"
 ---
 
 ## Description

diff --git a/docs/tools/chrome-extension/code-explanation.md b/docs/tools/chrome-extension/code-explanation.md
@@ -5,6 +5,26 @@ sidebar_label: "Code Explanation"
 keywords:
   - "ai"
   - "code explanations"
+  - "Code Interpretation"
+  - "Programming Insights'
+  - "Code Understanding"
+  - "Code Walkthrough"
+  - "Algorithm Explanation"
+  - "Software Development Insights"
+  - "AI in Code"
+  - "Code Analysis"
+  - "Code Breakdown"
+  - "Code Commentary"
+  - "Source Code Explanation"
+  - "Software Engineering Insights"
+  - "Code Decoding"
+  - "Programming Logic Explanation"
+  - "Code Comprehension"
+  - "Explanation of Algorithms"
+  - "AI in Programming"
+  - "Code Insight"
+  - "Software Design Explanation"
+  - "Code Flow Explanation"
 ---
 
 Generate an explanation for a block of code using the blue plus button that is displayed when hovering over a line. To select a block of code, hover over the starting line, click, and drag the blue plus button until you reach the desired line.

diff --git a/docs/tools/chrome-extension/highlights.md b/docs/tools/chrome-extension/highlights.md
@@ -5,6 +5,17 @@ sidebar_label: "Highlight"
 keywords:
   - "highlights"
   - "posting"
+  - "Content Highlights"
+  - "Featured Content"
+  - "Noteworthy Points"
+  - "Key Takeaways"
+  - "Highlighted Information"
+  - "Standout Features"
+  - "Important Details"
+  - "Highlighted Sections"
+  - Posting Highlights"
+  - "Notable Content"
+  - "Highlighted Insights"
 ---
 
 You can access the post to highlight it from the popup window in the extension. When you clicked, it will automatically, populate the PR or issue title, here you can use our AI functions to get a summary of the highlight similar to the PR summary.