You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* star search ([#300](https://github.com/open-sauced/docs/issues/300)) ([585c43d](https://github.com/open-sauced/docs/commit/585c43d57e4d767fbc92d0d9db7c51a8f1467aaa))
* logo readme.md changed to new one ([#299](https://github.com/open-sauced/docs/issues/299)) ([443ee08](https://github.com/open-sauced/docs/commit/443ee083da0a1e1c3d81148801915d4e4f52ae02))
@@ -99,7 +99,7 @@ Sharing the story of your hard work is an opportunity to connect with the reader
99
99
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."
100
100
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."
101
101
102
-
#### Highlighting Dev.to Blog Posts
102
+
#### Highlighting Blog Posts
103
103
104
104
1.**Describe the topic**: Begin with an interesting blog post summary to help your peers and potential recruiters understand your writing.
105
105
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?
Copy file name to clipboardexpand all lines: docs/features/repo-pages.md
+28-14
Original file line number
Diff line number
Diff line change
@@ -12,35 +12,49 @@ keywords:
12
12
- "Repository stars"
13
13
---
14
14
15
-
Repository pages allow you to view specific information (forks and stars) about a repository hosted on GitHub.
15
+
Repository Pages allow you to view specific information about a repository hosted on GitHub through a detailed visual and analytical representation of the project.
16
+
17
+
These pages are designed to help you gain insights into various aspects of project activity, health, and community engagement.
16
18
17
19
## Accessing a Repository Page
18
20
19
-
To view a repository page, follow these steps:
21
+
There are a couple of ways to access a repository page:
20
22
21
-
Open a web browser and navigate to the following URL structure:
23
+
1.**From the Repository Insights Page**: If you're already on the Repository Insights Page, you can click on the repository name to view the repository page.
24
+
2.**From the search bar**: You can search for a repository by entering the repository name in the search bar. Once you find the repository you're looking for, click on the repository name to view the repository page.
25
+
3.**Directly from the URL**: You can also access a repository page directly by entering the URL in your web browser:
22
26
23
-
`https://app.opensauced.pizza/s/{org}/{repo}`
27
+
```text
28
+
https://app.opensauced.pizza/s/{org}/{repo}
29
+
```
24
30
25
-
Replace `{org}` with the name of the organization that owns the repository you want to view. Replace `{repo}` with the name of the specific repository.
31
+
Replace `{org}` with the name of the organization that owns the repository you want to view. Replace `{repo}` with the name of the specific repository.
26
32
27
-
For example, to view the `next.js` repository created by the `Vercel` organization, you would use the following URL:
33
+
For example, to view the `next.js` repository created by the `Vercel` organization, you would use the following URL:
Here are some general things you might find on a repository page:
43
+
### Overview Dashboard
44
+
45
+
The charts on our repository pages offer a visual representation of several key metrics:
38
46
39
-
-**Repository name and organization/user**: This is displayed prominently at the top of the page.
40
-
-**Metrics**: This includes the number of stars and forks the repository has on GitHub.
47
+
- **Issue Resolution Trends**: Our line graphs display the number of issues opened versus those closed within specified periods, offering insights into the effectiveness of problem resolution and how issue volume changes over time.
48
+
- **Pull Request Dynamics**: Analyze pull request activity by the numbers of pull requests opened, closed, and merged. This provides an overview of collaboration efficiency and code review processes.
49
+
- **Stars and Forks Over Time**: The number of stars and forks the project receives over time, illustrating the project's growth in popularity and its spread within the developer community.
50
+
- **[Lottery Factor](../welcome/glossary.md#lottery-factor)**: This unique metric highlights the dependency on key contributors. A project is considered vulnerable if 2 or fewer contributors account for 50% or more of the project's contributions. This indicates a potential risk if one of these contributors leaves the project.
41
51
42
52
You can use the time range filter to view the number of stars and forks over different periods, such as the last 7 days, month, or the last year.
43
53
44
-
Currently, only publicly available repositories on GitHub can be viewed through Open Sauced Pizza's repository pages.
54
+
### Contributor Dashboard
55
+
56
+
The Contributor Dashboard offers a comprehensive view of all contributors, showcasing the frequency and size of each person’s contributions.
57
+
58
+
Currently, only publicly available repositories on GitHub can be viewed through repository pages.
45
59
46
-
Repository pages on Open Sauced Pizza provide a way to explore and learn about open source code repositories hosted on GitHub. While you cannot create or edit them directly on Open Sauced Pizza yet, you can add them to your [Repository Insight pages](https://docs.opensauced.pizza/features/repo-insights/).
60
+
Repository pages provide a way to explore and learn about open source projects on GitHub. While you cannot create or edit them directly on Open Sauced Pizza yet, you can add them to your [Repository Insight pages](https://docs.opensauced.pizza/features/repo-insights/).
**StarSearch** is our AI-powered feature that provides in-depth insights into contributor history and activities, enabling users to query GitHub activities and analytics through natural language. This tool is designed to provide you with insights into GitHub projects and contributions without requiring any coding or complex queries, bringing transparency and a new depth of knowledge about open source projects. It's your copilot for git history.
17
+
18
+
## Key Features
19
+
20
+
-**Real-Time Insights**: Access up-to-date information about GitHub contributions, issues, and projects.
21
+
-**Conversational Queries**: Use natural language to explore GitHub data.
22
+
-**Cross-Project Analysis**: Identify connections between different projects and technologies.
23
+
-**Contributor Discovery**: Pinpoint key contributors and the work they've done.
24
+
25
+
### What Can You Discover with StarSearch?
26
+
27
+
-**Contributor Activities**: Learn the details of contributions and contributors.
28
+
-**Key Contributors**: Identify the key contributors to projects and ecosystems and their impact on the projects.
29
+
-**Work-Based Connections**: Find potential collaborators based on their contributions to specific projects.
30
+
-**Hidden Experts**: Discover untapped talent in the ecosystem.
31
+
32
+
33
+
34
+
## Getting Started with StarSearch
35
+
36
+
1. Log in to [Your OpenSauced Account](https://app.opensauced.pizza/)
37
+
2. Navigate to [https://app.opensauced.pizza/star-search](https://app.opensauced.pizza/star-search) or click the StarSearch tab in the sidebar or navigation bar.
38
+
39
+
### User Guide
40
+
41
+
#### Basic Queries
42
+
43
+
- What type of pull requests has \{username} worked on?
44
+
- Who are the best developers that know \{technology} and are interested in \{technology}?
45
+
- Who are the most prevalent contributors to the \{technology} ecosystem?
46
+
- Show me the [lottery factor](https://docs.opensauced.pizza/welcome/glossary/#lottery-factor) for contributors in the \{repository} project?
47
+
48
+
### FAQs
49
+
50
+
-**Can I continue conversations with StarSearch?**
51
+
- Not yet, but stay tuned!
52
+
-**Can I access my search history?**
53
+
- This feature is currently not available, but we plan to include it in future updates.
54
+
-**What time range does StarSearch cover?**
55
+
- StarSearch is most accurate from March 1, 2024.
56
+
-**Is StarSearch always right?**
57
+
- StarSearch is an AI tool and may not always be accurate. We recommend verifying the information.
58
+
59
+
## Feedback
60
+
61
+
Your feedback helps us improve StarSearch. If you have any suggestions or questions, please create a [discussion post](https://github.com/orgs/open-sauced/discussions/categories/general-feedback-or-bugs) or open an [issue](https://github.com/open-sauced/app/issues). You can also use the thumbs-up or thumbs-down buttons on the StarSearch page to let us know if the information was helpful.
Copy file name to clipboardexpand all lines: docs/features/workspaces.md
+35-23
Original file line number
Diff line number
Diff line change
@@ -16,17 +16,17 @@ In the OpenSauced app, your work unfolds within a Workspace: a virtual environme
16
16
17
17
## Understanding Workspaces
18
18
19
-
You can navigate your workspaces from the sidebar. Each workspace has its own dashboard, which includes the repositories you're tracking in the workspace.
19
+
You can navigate your Workspaces from the sidebar. Each Workspace has its own dashboard, which includes the repositories you're tracking in the Workspace.
By default, all workspaces are public. This means that anyone with the link to your workspace can view it, including all of your Insight Pages in the workspace. If you want to make your workspace private, you can upgrade your account to a PRO plan.
23
+
By default, all Workspaces are public. This means that anyone with the link to your Workspace can view it, including all of your Insight Pages in the Workspace. If you want to make your Workspace private, you can upgrade your account to a PRO plan.
24
24
25
25
### The Sidebar
26
26
27
27
The expandable sidebar includes:
28
28
29
-
- Options for creating and viewing workspaces.
29
+
- Options for creating and viewing Workspaces.
30
30
- Access to your Contributor and Repository Insights pages.
31
31
- Links to support.
32
32
@@ -40,66 +40,78 @@ We recently had a naming change. The [Contributors Insights](contributor-insight
40
40
41
41
### Your Workspaces
42
42
43
-
In your workspace dashboards, you can create, view, and manage your workspaces.
43
+
In your Workspace dashboards, you can create, view, and manage your Workspaces.
44
44
45
45
#### Repositories Dashboard
46
46
47
47
48
48
49
49
Within the repositories dashboard, you can view the following metrics, which are over a period of thirty days by default:
50
50
51
-
-**Pull Requests**: This includes the total opened and merged pull requests for the repositories included in your workspace, as well as the velocity of pull requests being merged.
52
-
-**Issues**: This includes the total opened and closed issues for the repositories included in your workspace, as well as the velocity of issues being closed.
53
-
-**Engagement**: This includes the total stars, forks, and activity ratio for the repositories included in your workspace.
51
+
-**Pull Requests**: This includes the total opened and merged pull requests for the repositories included in your Workspace, as well as the velocity of pull requests being merged.
52
+
-**Issues**: This includes the total opened and closed issues for the repositories included in your Workspace, as well as the velocity of issues being closed.
53
+
-**Engagement**: This includes the total stars, forks, and activity ratio for the repositories included in your Workspace.
54
+
55
+
#### Activity Dashboard
56
+
57
+
The Activity Dashboard provides a centralized view of recent activity across repositories, including detailed tables for Pull Requests (PRs) and Issues. These tables offer insights into ongoing contributions, bug fixes, feature requests, and more.
58
+
59
+
##### Pull Requests Table
60
+
61
+
The Pull Requests table lists recent PRs across the repositories in your Workspace, providing details to track progress and contributions. It includes information on the current status of the PR, the number of files changed, the number of additions and deletions, and timestamps for updates, creation, closure, and merging.
62
+
63
+
##### Issues Table
64
+
65
+
The Issues table displays recent issues from the repositories in your Workspace, helping you identify and track bugs, feature requests, and ongoing discussions. It gives you insight into the current status of the issue, the number of reactions, and timestamps for updates, creation, and closure.
54
66
55
67
## How to Create or Access a Workspace
56
68
57
-
To create a workspace, start by accessing the **Workspace switcher** in the sidebar. From there, you can create a new workspace or view an existing one.
69
+
To create a Workspace, start by accessing the **Workspace switcher** in the sidebar. From there, you can create a new Workspace or view an existing one.
Whenever you select "Home", you'll be taken to the last workspace you opened.
77
+
Whenever you select "Home", you'll be taken to the last Workspace you opened.
66
78
67
79
:::
68
80
69
81
### How to Add Repositories to a Workspace
70
82
71
-
If you're creating a new workspace, you'll have the option to add repositories at the time of creation.
83
+
If you're creating a new Workspace, you'll have the option to add repositories at the time of creation.
72
84
73
-
Start by creating a workspace name, then click "Add repositories." You'll have three options for adding repositories:
85
+
Start by creating a Workspace name, then click "Add repositories." You'll have three options for adding repositories:
74
86
75
-
1.**Search for Repositories**: Use our search tool by adding an organization name, followed by the repository name, and add them to your workspace.
76
-
2.**Import a GitHub Organization**: Connect to your GitHub organizations to create a workspace from an organization. (If you're having trouble with this, see the "[Sync Your GitHub Team](../welcome/faqs.md#sync-your-github-team)" section in our FAQs.)
77
-
3.**Import Repositories**: Paste a list of repositories to add to your workspace.
87
+
1.**Search for Repositories**: Use our search tool by adding an organization name, followed by the repository name, and add them to your Workspace.
88
+
2.**Import a GitHub Organization**: Connect to your GitHub organizations to create a Workspace from an organization. (If you're having trouble with this, see the "[Sync Your GitHub Team](../welcome/faqs.md#sync-your-github-team)" section in our FAQs.)
89
+
3.**Import Repositories**: Paste a list of repositories to add to your Workspace.
78
90
79
-
Once your repositories are added, you'll be able to see them in your repository dashboard. You can also edit your workspace to add or remove repositories anytime.
91
+
Once your repositories are added, you'll be able to see them in your repository dashboard. You can also edit your Workspace to add or remove repositories anytime.
80
92
81
93
### Changing Workspaces
82
94
83
-
Anything you create in a workspace is specific to that workspace. When you switch workspaces, you'll see the Repository and Contributor Insights specific to that workspace.
95
+
Anything you create in a Workspace is specific to that Workspace. When you switch Workspaces, you'll see the Repository and Contributor Insights specific to that Workspace.
84
96
85
97
## How to Share a Workspace
86
98
87
-
You can share your workspace with others by copying the URL and sending it to them. If your workspace is private (a PRO plan feature), only those with access to the workspace will be able to view it.
99
+
You can share your Workspace with others by copying the URL and sending it to them. If your Workspace is private (a PRO plan feature), only those with access to the Workspace will be able to view it.
88
100
89
101
## Team Workspaces
90
102
91
-
Team workspaces are part of the PRO plan and are designed to help teams collaborate on and understand open source projects. Team workspaces are public by default. However, you can switch it to private in your settings so only team members can view the workspace.
103
+
Team Workspaces are part of the PRO plan and are designed to help teams collaborate on and understand open source projects. Team Workspaces are public by default. However, you can switch it to private in your settings so only team members can view the Workspace.
92
104
93
-
By upgrading to a team workspace, you'll have unlimited Contributor and Repository Insights, as well as the ability to toggle between private and public visibility.
105
+
By upgrading to a team Workspace, you'll have unlimited Contributor and Repository Insights, as well as the ability to toggle between private and public visibility.
94
106
95
107
:::info
96
108
97
-
The visibility of your Insights Pages is determined by the visibility of the workspace. If your workspace is public, your insights will be public. If your workspace is private, your insights will be private.
109
+
The visibility of your Insights Pages is determined by the visibility of the Workspace. If your Workspace is public, your insights will be public. If your Workspace is private, your insights will be private.
98
110
99
111
:::
100
112
101
-
You can add someone to your workspace by clicking on the "Edit" button located at the top right of the workspace dashboard and entering the username of the workspace member you would like to add.
113
+
You can add someone to your Workspace by clicking on the "Edit" button located at the top right of the Workspace dashboard and entering the username of the Workspace member you would like to add.
Once you add a member to a workspace, they will be able to view the workspace and its contents. You will also be able to edit their permissions for the workspace, including owner, editor, or viewer permissions. This workspace will now appear in their workspace switcher.
117
+
Once you add a member to a Workspace, they will be able to view the Workspace and its contents. You will also be able to edit their permissions for the Workspace, including owner, editor, or viewer permissions. This Workspace will now appear in their Workspace switcher.
0 commit comments