feat: Add a Contributors guide (open-sauced#229)

* docs: add explainer page about Dev Card feature

* docs: add explainer page about the dev card

* Revert "docs: add explainer page about the dev card"

This reverts commit 98f6a72.

* Install the CodeSee workflow. Learn more at https://docs.codesee.io

* feat: did first two sections of the guide

* feat: add contributor guide to sidebar

* fix: rename contributors file

* feat: add comments

* Revert "Install the CodeSee workflow. Learn more at https://docs.codesee.io"

This reverts commit f8bbc83.

* Revert "docs: add explainer page about Dev Card feature"

This reverts commit af0ebdd.

* fix: revise paragraph about contributors in Lists

* fix: change wording

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: change wording and add link

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: omit preposition

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: change placement of words

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: change wording & add link to explainer page

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: change wording

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: making the sentence more contributor-friendly

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* feat: add explanation about tracking contributions

* fix: revise bullet points in section about insights

* fix: revise bullet points in highlighting issues section

* feat: adding link to blog post

* fix: omit unwanted files

* fix: make statements more contributor friendly

* fix: revise sentence

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: made the sentences more contributor-centric

* fix: revise last two bullet points in section about insights page

* fix: turn h2 into h3

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: change file path

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: change wording

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: change file path for list data

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: add a comma

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: revise typo

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: revise words

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: revise words

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: change wording

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: revise sentence

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: revise formatting

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* feat: add section about creating a public profile

* feat: add a sentence about four tabs

* feat: turn paragraph about Explore tab into its own section

* fix: made some revisions

* fix: revise formatting

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: revise sentence

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: omit preposition

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: revise wording

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: improve sentence

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: revise sentence

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

* fix: revise sentence

* feat: elaborate more on how the CSV file can benefit students

* fix: revise paragraph in the Reports section

* Revise intro paragraph for clarity

* Update profile section to clearly show button

* Finish updating section

* Add image of settings

* Update Profile section

* Add explore section

* Add images

* feat: elaborate on paragraph

* fix: made some revisions

* fix: revised grammar and formatting issues

* Update profile section

* Update Highlights

* Update text

* Clean up Insight section

* Revise Lists section and add a conclusion

* Style list

* Add a Takeaways section

* fix: wording, punctuation, and a broken link

* fix: delete first paragraph in conclusion section to remove duplication

* Update docs/contributors/contributors-guide.md

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

---------

Co-authored-by: codesee-maps[bot] <86324825+codesee-maps[bot]@users.noreply.github.com>
Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>
Co-authored-by: Ayu Adiati <retno.ayu98@gmail.com>
Co-authored-by: bekahhw <rhawrot@gmail.com>
Co-authored-by: BekahHW <34313413+BekahHW@users.noreply.github.com>

docs/contributors/contributors-guide.md

@@ -0,0 +1,198 @@
+---
+id: contributors-guide-to-open-sauced
+title: "Contributors Guide to OpenSauced"
+sidebar_label: Contributors Guide to OpenSauced
+keywords:
+  - contributors
+  - guides
+---
+
+## Introduction to OpenSauced for Contributors
+
+OpenSauced is a platform dedicated to empowering you, the contributor, in your open source journey. With OpenSauced, you can find repositories to contribute to, track your contributions, gain insights into your favorite open source projects, and find new contributors to connect with.
+
+## Getting Started
+
+To get started, you will need to create an account on OpenSauced. You can do this by visiting the [app.opensauced.pizza](https://app.opensauced.pizza) and clicking the "Connect with GitHub" button. You will be prompted to sign in with your GitHub account. Once you have signed in, you will be redirected to the OpenSauced dashboard. A great place to get started is by creating your profile.
+
+## Creating Your Profile
+
+Creating your profile is a great way to showcase your open source contributions, connect with other contributors and maintainers, and share during a job search. Here are some steps to help you get started:
+
+1. After creating your account, navigate to "Settings".
+   ![settings](../../static/img/settings.png)
+
+2. Once there, you will be asked to add your name, bio, links to your social media accounts, timezone, and other forms of contact information.
+   :::tip
+   Don't forget to add your personal site, GitHub Sponsors URL, and LinkedIn so people can connect with you and learn more about your work.
+   :::
+3. In the "Interests" section, select the various programming languages and topics you are interested in. Setting them helps us recommend open source projects that fit your interests.
+4. Manage your email preferences.
+
+### Your Profile
+
+Your profile is a great resource for showcasing your contributions and sharing your open source work with others.
+
+![your profile](../../static/img/profile.png)
+
+On your profile, you will see the "Highlights" section, which you can learn more about [in this section](#highlights-connecting-and-recognizing-contributions), and three other tabs:
+
+- **Contributions**: This tab includes a graph showing the number of pull requests (PRs) you have opened, [the velocity of your PRs](../welcome/glossary.md#pr-velocity), and the number of repositories that you have contributed to. Underneath the graph, there is a "Latest PRs" chart, which shows a list of current and recent PRs. This tab is helpful if you want to showcase a steady and consistent open source contribution experience.
+- **Connections**: For pro accounts, you can reach out to other contributors and maintainers to collaborate on projects or to learn from them.
+- **Recommendations**: This tab includes a list of open source projects that are chosen based on the programming languages you picked in the "Interests" section of your public profile. It is useful if you're looking for new projects to contribute to.
+
+## Explore: Finding Your Next Open Source Project
+
+The "Explore" tab is a great place to start if you're looking for a new open source project to contribute to or want to find repositories for potential job opportunities. Here, you can find a list of open source projects and filter them by language, top repos, recent, most active, and more.
+
+Once you've selected your filters, you'll be able to see the contributors, spam, and activity levels of the repository. Understanding the activity level and PR velocity of a repository can help you determine if it's a good fit for you to contribute to and what to expect when you submit a PR.
+
+For example, if you wanted to look for a JavaScript project to contribute to, you would select "JavaScript" from the language dropdown and "Most Active" from the filter dropdown to see the most active JavaScript projects on GitHub. If you want to keep track of the repositories you're interested in contributing to, you can add them to your [Insights page](../features/insights.md).
+
+## Highlights: Connecting and Recognizing Contributions
+
+Leveraging OpenSauced's [Highlights](../features/highlights.md) feature is a great way for you to showcase your valuable contributions to open source projects. You can curate and share your achievements and milestones and bring visibility to your hard work.
+
+The Highlights feature allows you to:
+
+- Talk about issues that you raised.
+- Share Dev.to blog posts that you've written.
+- Display PRs that showcase your contributions.
+
+### Creating a New Highlight
+
+There are two ways to create a new highlight:
+
+1. Paste the URL to your PR, Issue, or Dev.to blog post (shown in blue below).
+2. Choose from a list of suggestions (shown in orange below).
+
+![highlight suggestions](../../static/img/highlights.png)
+
+If you're adding a blog post, you'll need to associate it to a repository by clicking the "Add a repo" button.
+
+Finally, it's time to add the details of your highlight. You can write the description yourself or use the auto-summarize button to generate one.
+
+![gif of creating a highlight](../../static/gif/highlight.gif)
+
+### Writing an Effective Highlight
+
+Sharing the story of your hard work is an opportunity to connect with the reader, which could include potential collaborators or recruiters. Here are some tips to help you write effective stories for your highlights:
+
+#### Highlighting Issues
+
+1. **Share your motivation**: Briefly explain why you raised the issue. For example, "I'm passionate about improving accessibility because I believe everyone should have equal access to information."
+2. **Summarize the issue**: Briefly describe the issue you wrote so your readers have context. For example, "I raised an issue to add alt text to images in the project's 'About Us' page."
+3. **Describe the impact:** Briefly state how the resolution of the issue will improve the project. For example, "This will help people who use screen readers to understand the content of the images."
+
+#### Highlighting PRs
+
+1. **Describe the PR**: Start with a clear summary of what your PR accomplishes. For example, "I added a new feature to the project's Chrome Extension that allows users to summarize content."
+2. **Highlight your solution and its impact**: Briefly describe the solution, any challenges you faced, or any part of the PR you're particularly proud of. For example, "Initially, I faced challenges with the API, but I was able to resolve them using a different endpoint."
+3. **Reflect on your experience**: Mention what you learned from working on the PR. For example, "I learned a lot about the Chrome Extension API and how to use it to create new features."
+
+#### Highlighting Dev.to Blog Posts
+
+1. **Describe the topic**: Begin with an interesting blog post summary to help your peers and potential recruiters understand your writing.
+2. **Discuss the inspiration**: Explain why you wrote this blog post. Is it to guide others on improving their coding skills, raise awareness about an issue in the tech community, or display your progress in learning a new programming language?
+3. **End with a call-to-action**: Encourage readers to read and engage with the post, whether by commenting or sharing it with others on social media.
+
+## Insights: Connecting Your Repositories
+
+OpenSauced [Insights](../features/insights.md) allows you to track open source projects you are interested in. You can use Insights Pages to track repositories' growth, analyze work, and connect with others.
+
+### Why Create an Insights Page
+
+- **To track projects you're working on**: Tracking projects you're working on can help you stay up-to-date with the latest activity, trends, and connect with other contributors.
+- **To identify potential projects to contribute to**: If you're looking for a new project to contribute to, you can use the Insights feature to track active projects that are looking for contributors. You can use the Explore tool to find new projects to contribute to and track them with your Insights page.
+- **To network and engage with the community**: Finding people to work and connect with can be challenging. Through the feature's "Contributors" tab, you can connect with your network.
+- **To track the activity of a topic you're interested in**: Keeping up with the latest trends and activity in a specific topic can be challenging. You can use the Insights feature to track the activity of a specific topic and find new projects to contribute to. For example, you can create an [Insight page for Active AI Repositories](https://app.opensauced.pizza/pages/BekahHW/1055/dashboard).
+- **To track the activity of your favorite programming languages**: If you're interested in tracking the activity of your favorite programming languages, you can use the Insights feature to track the open source projects that are using them.
+- **To aid in the job search**: If you're looking for a job, you can use the Insights feature to track the activity of the organizations you're interested in working on. This can help you understand the activity level of the repositories and the types of contributions that are being made, and even identify which company you want to contribute to.
+- **Curating collections for interest groups**: You can curate and share repositories focusing on sectors and programming languages that interest you.
+
+### Creating a New Insight Page
+
+To track the repositories, click the "Insights" tab on the top left bar. You will be redirected to a page where you can create your new Insight Page.
+
+There are two ways to add repositories to your Insight Page:
+
+1. **Sync GitHub organization**: Syncing your GitHub organizations is a good idea if you want to keep track of their open source project activities and trends.
+2. **Connect individual repositories**: Connecting individual repositories is a good idea if you want to keep track of the contributions of a specific repository or group of repositories.
+
+![sync insights gif](../../static/gif/insight-page-demo.gif)
+
+### Using Your Insights Page
+
+Once you have connected your repositories, you will be redirected to your Insight Page. Here, you will see a dashboard with an overview of the repositories and the contributors who have contributed to them.
+
+There are four tabs that provide you with more information on these repositories:
+
+- **Reports**: The "Reports" tab allows paid users to filter for more information about the repositories over the last 30 days and to generate a downloadable CSV.
+- **Repositories**: This tab contains information such as activity levels, PR overview, PR velocity, spam PRs, contributors, and activity stats over the last 30 days.
+- **Contributors**: The "Contributors" tab allows you to view more detailed information about other contributors, including Activity, Repositories, the date of their last contribution, Time Zone, and the number of contributions.
+- **Activity**: The "Activity" tab gives you a graph view with more detailed information on each contributor when you click their image, including their latest PRs and repositories they've contributed to.
+
+#### Repositories
+
+If you're looking for an active project to contribute to, this tab can help you as it contains information such as Activity, PR Overview, PR Velocity, Spam, Contributors, and activity stats over the last 30 days. This information is also a good way to connect with others on the project or where to find support.
+
+![repositories tab](../../static/img/repos-insights.png)
+
+#### Contributors
+
+The "Contributors" tab allows you to view more detailed information about other contributors, including Activity, Repositories, the date of their last contribution, Time Zone, and the number of contributions. This can be a great way to find others to collaborate with or recommend for jobs.
+
+![contributors insight list](../../static/img/contributors-insights.png)
+
+:::tip
+Want to learn more about your peers? You can select them and add them to a list.
+:::
+
+To learn more about these features, see [Understanding Insights Data](../maintainers/understanding-insights.md).
+
+## Lists: Connecting with Contributors
+
+The [Lists](../features/lists.md) feature helps you connect with other contributors or learn more about what others are up to in open source. With this feature, you can categorize, watch, and check out different groups of contributors within open source projects.
+
+### What You Can Do With Lists?
+
+There are many things you can do with this feature, but here are some ideas to get you started:
+
+- **Track personal contributions**: If you create a list of your personal contributions, you can track them and see how you're doing over time, as well as get a breakdown of the type of contributions you're making, including commits, created PRs, reviewed PRs, and created issues.
+- **Learn about what other contributors are doing in open source**: You can learn where other contributors are contributing, what they're working on, and how active they are in the open source community.
+- **See who's using OpenSauced Highlights feature**: You can see who's using the Highlights feature and show them support by giving an emoji reaction.
+- **Track contributors for job opportunities**: If you're looking for a job, you can track the activity of the contributors you're interested in working with. This helps you understand the activity level of the repositories and the types of contributions being made, and you can even identify which company you want to contribute to.
+
+### Creating a New List
+
+1. Click the "Lists" tab on the Insights hub to create a new list. You will be redirected to a page where you can create your new list.
+2. Click on the "New List" button to start a new list.
+3. Give your list a name.
+4. Choose your page visibility. You can choose to make your list public or private. By default, it is set to private.
+5. Add contributors to your list by searching for their GitHub username, syncing your GitHub Team, or importing your GitHub Following.
+
+![contribution sync gif](../../static/gif/contributors-sync-list.gif)
+
+## Using Your List
+
+Once you have created your list, you will be redirected to your List Page. Here, you will see a dashboard with an overview of the contributors.
+
+There are three tabs that provide you with more information on these repositories:
+
+- **Overview**: The "Overview" tab gives you a high-level view of the contributors in your list, including the total number of commits in the last 30 days and the types of contributors on your list: Active, New, and Alumni.
+- **Activity**: The "Activity" tab gives you a graph view with more detailed information on each contributor, including the type of activity, repositories they've contributed to, and how they compare to each other.
+- **Highlights**: The "Highlights" tab gives you a list of the highlights that the contributors in your list have created. This is a great way to see what other contributors are up to and to show them support.
+
+To learn more about these features, see [Understanding Lists Data](../maintainers/understanding-lists-data.md).
+
+## Takeaways
+
+- **Create Your Profile**: Creating your profile is a great way to display your open source contributions, connect with other contributors and maintainers, and share during a job search.
+- **Explore**: The "Explore" tab is a great place to find new open source projects to contribute to.
+- **Highlights**: Leveraging OpenSauced's Highlights feature is a great way for you to showcase your valuable contributions to open source projects.
+- **Insights**: OpenSauced Insights allows you to track open source projects you are interested in.
+- **Lists**: The Lists feature helps you understand other contributors or track your own work in open source.
+
+## Conclusion
+
+We hope this guide has helped you get started with OpenSauced and that you're excited to use the platform to connect with other contributors and maintainers, track your contributions, and find new open source projects to contribute to. If you have any questions or need help, please don't hesitate to reach out to us. We're here to help you succeed in your open source journey.

sidebars.js

@@ -40,6 +40,12 @@ module.exports = {
         "maintainers/understanding-lists",
       ],
     },
+    {
+      type: "category",
+      label: "Contributors",
+      collapsed: false,
+      items: ["contributors/contributors-guide-to-open-sauced"],
+    },
     {
       type: "category",
       label: "Community",