diff --git a/docs/chrome-extension/quick-access-to-opensauced-links.md b/docs/chrome-extension/quick-access-to-opensauced-links.md deleted file mode 100644 index ffd8a349..00000000 --- a/docs/chrome-extension/quick-access-to-opensauced-links.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: opensauced-links -title: 'Code Explanation' -sidebar_label: 'Quick Access to OpenSauced' -keywords: - - opensauced - - links ---- - -![Quick Access to OpenSauced](../../static/img/extension-links.png) \ No newline at end of file diff --git a/docs/community/faqs.md b/docs/community/faqs.md index 62fdaf8c..57626a69 100644 --- a/docs/community/faqs.md +++ b/docs/community/faqs.md @@ -9,7 +9,7 @@ keywords: 1. **How do I find good first issues?** We believe that [good first issues don't exist](https://opensauced.pizza/blog/good-first-issues-dont-exist), and the best way to find an issue to work on is to create the issue yourself. - However, sites like [good first issues](https://goodfirstissues.com/) and [first timers only](https://www.firsttimersonly.com/) can lead you to projects and issues worth working on. You can also use the `good first issue` label in the search engine of the project you want to contribute to. Check out [this guide](https://www.freecodecamp.org/news/how-to-find-good-first-issues-on-github/) by our Triage Team member, Christine Belzie, to learn more. + However, sites like [good first issues](https://goodfirstissues.com/) and [first timers only](https://www.firsttimersonly.com/) can lead you to projects and issues worth working on. You can also use the `good first issue` label in the search engine of the project you want to contribute to. Check out [this guide](https://www.freecodecamp.org/news/how-to-find-good-first-issues-on-github/) to learn more. **Additional resources**: @@ -17,7 +17,7 @@ We believe that [good first issues don't exist](https://opensauced.pizza/blog/go - [Intro to Open Source Course](https://intro.opensauced.pizza/) 2. **My contribution does not show up on my OpenSauced profile. How do I fix it?** -Create an [insight page](https://intro.opensauced.pizza/#/05-how-to-contribute-to-open-source?id=discovering-open-source-with-opensauced) or adding your merged pull request to [the highlights page](https://intro.opensauced.pizza/#/06-the-secret-sauce?id=develop-your-open-source-resume). +Create an [insight page](https://app.opensauced.pizza/hub/insights) or add your merged pull request to [a highlight](https://app.opensauced.pizza/feed). 3. **I want to provide feedback on OpenSauced.** We love feedback. Post your suggestion in our [feedback repository](https://github.com/orgs/open-sauced/discussions). diff --git a/docs/community/welcome-to-the-community.md b/docs/community/welcome-to-the-community.md index 80c00df6..c57964b8 100644 --- a/docs/community/welcome-to-the-community.md +++ b/docs/community/welcome-to-the-community.md @@ -32,13 +32,14 @@ The OpenSauced community is a group of open-source enthusiasts who are passionat You can get involved in the OpenSauced community in a few ways: -- Share your Contributions! We love to see what you're working on. Highlight your contributions on [OpenSauced](https://insights.opensauced.pizza/feed). +- Share your Contributions! We love to see what you're working on. Highlight your contributions on [OpenSauced](https://app.opensauced.pizza/feed). - Open an issue or ask to be assigned to an existing issue on any of our [OpenSauced repositories](https://github.com/open-sauced). - Share what you're working on, ask questions, or mentor new contributors in our [Discord](https://discord.gg/opensauced). +- Provide feedback on our [GitHub Discussions](https://github.com/orgs/open-sauced/discussions). ## Resources on Getting Started with Open Source -Getting started with open source can be quite daunting for beginners, so we've put together some resources to help you get started. +Getting started with open source can be challenging, so we've put together some resources to help you get started. -- πŸ“ Check out our [Dev blog](https://dev.to/opensauced) where we provide resources for open-source contributors. -- πŸ“– Take our [Intro to Open Source Course](https://intro.opensauced.pizza/#/) to help you get started with open-source. +- πŸ“ Check out our [Dev blog](https://dev.to/opensauced) where we provide resources for open source contributors. +- πŸ“– Take our [Intro to Open Source Course](https://intro.opensauced.pizza/#/) to help you get started with open source. - πŸ“… Join our [#100DaysOfOSS Challenge](https://docs.opensauced.pizza/community/100-days-of-oss/) to help you grow your skills and gain real-world experience in open source. \ No newline at end of file diff --git a/docs/maintainers/maintainers-guide.md b/docs/contributing/maintainers-guide.md similarity index 100% rename from docs/maintainers/maintainers-guide.md rename to docs/contributing/maintainers-guide.md diff --git a/docs/technical/introduction-to-storybook.md b/docs/contributing/technical/introduction-to-storybook.md similarity index 100% rename from docs/technical/introduction-to-storybook.md rename to docs/contributing/technical/introduction-to-storybook.md diff --git a/docs/technical/resolve-merge-conflicts.md b/docs/contributing/technical/resolve-merge-conflicts.md similarity index 82% rename from docs/technical/resolve-merge-conflicts.md rename to docs/contributing/technical/resolve-merge-conflicts.md index 94a0b15a..46b4ab11 100644 --- a/docs/technical/resolve-merge-conflicts.md +++ b/docs/contributing/technical/resolve-merge-conflicts.md @@ -10,12 +10,6 @@ Pretty often when opening a pull request it is very likely to run into merge con To better illustrate the commands listed here at will use commits and screenshots from [open-sauced#1078](https://github.com/open-sauced/open-sauced/pull/1078). -In literally every case it is advised _**not**_ to use the `Resolve conflicts` button as follows: - -![don't resolve conflicts like this](../../static/img/contributing-resolve-merge-conflicts-dont-do.png) - -The above will at best achieve a ready-to-merge pull request with visible inconsistencies. - ## Repository setup @@ -74,7 +68,7 @@ git merge origin/main --no-ff -v You will see something similar to: -![proper merge but results in conflicts](../../static/img/contributing-resolve-merge-conflicts-merge-conflicts.png) +![proper merge but results in conflicts](../../../static/img/contributing-resolve-merge-conflicts-merge-conflicts.png) ## Review changes @@ -86,7 +80,7 @@ git diff package.json It will look like this: -![review merge conflicts](../../static/img/contributing-resolve-merge-conflicts-review-conflicts.png) +![review merge conflicts](../../../static/img/contributing-resolve-merge-conflicts-review-conflicts.png) ## Resolve conflicts @@ -119,7 +113,7 @@ git commit That should look like this: -![commit merge message](../../static/img/contributing-resolve-merge-conflicts-commit-message.png) +![commit merge message](../../../static/img/contributing-resolve-merge-conflicts-commit-message.png) ## Push updated pull request @@ -132,7 +126,7 @@ git push It should look something like this: -![push updated pr](../../static/img/contributing-resolve-merge-conflicts-merge-success.png) +![push updated pr](../../../static/img/contributing-resolve-merge-conflicts-merge-success.png) ## Review your pull request @@ -140,11 +134,11 @@ The result of the above commands can be viewed at [283ff8cd788c550309ff0d1d5a9a5 GitHub will conveniently display only your merge conflict changes: -![view merge commit](../../static/img/contributing-resolve-merge-conflicts-view-merge-commit.png) +![view merge commit](../../../static/img/contributing-resolve-merge-conflicts-view-merge-commit.png) And it's ready to merge: -![ready to merge](../../static/img/contributing-resolve-merge-conflicts-ready-to-merge.png) +![ready to merge](../../../static/img/contributing-resolve-merge-conflicts-ready-to-merge.png) ## Dependency updates diff --git a/docs/technical/setup-repo-with-git.md b/docs/contributing/technical/setup-repo-with-git.md similarity index 100% rename from docs/technical/setup-repo-with-git.md rename to docs/contributing/technical/setup-repo-with-git.md diff --git a/docs/community/connections.md b/docs/features/connections.md similarity index 100% rename from docs/community/connections.md rename to docs/features/connections.md diff --git a/docs/community/dev-card.md b/docs/features/dev-card.md similarity index 100% rename from docs/community/dev-card.md rename to docs/features/dev-card.md diff --git a/docs/community/highlights.md b/docs/features/highlights.md similarity index 100% rename from docs/community/highlights.md rename to docs/features/highlights.md diff --git a/docs/community/insights.md b/docs/features/insights.md similarity index 100% rename from docs/community/insights.md rename to docs/features/insights.md diff --git a/docs/community/lists.md b/docs/features/lists.md similarity index 85% rename from docs/community/lists.md rename to docs/features/lists.md index fc92b3db..764c8f2f 100644 --- a/docs/community/lists.md +++ b/docs/features/lists.md @@ -5,7 +5,7 @@ sidebar_label: 'Lists' keywords: - lists --- -The Lists feature enables you to categorize, monitor, and analyze different groups of contributors within your open-source projects. With the Lists feature, gain granular insights into each contributor's activity and contributions. +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. Monitor individual commit histories, track who is actively engaged, identify churned or new contributors, and even compare the performance of contributors against each other. This encompasses a wide range of metrics such as code commits, created and reviewed Pull Requests (PRs), as well as issue creation and commenting. @@ -17,6 +17,6 @@ After logging in, navigate to your [Lists page](https://app.opensauced.pizza/hub There are two ways to add a list: 1. Explore Contributors: Use our explore tool to find contributors and create your list. 2. Import your GitHub following: -Connect to your GitHub to create a list with all the Contributors you follow +Connect to your GitHub to create a list with all the Contributors you follow. Once your list is created, you'll be able to see an overview of all the contributors in your list, a graph of their activity, and a detailed breakdown of the contributors. \ No newline at end of file diff --git a/docs/introduction.md b/docs/introduction.md index dc6a791b..ab237bd0 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -9,4 +9,12 @@ sidebar_label: Introduction to OpenSauced πŸ• [Watch this on YouTube](https://www.youtube.com/watch?v=h8gwrzis-dY&list=PLHyZ0Wz_A44XAE-6Gbd69pZLTdqWdwlBx&index=1&t=2s) -OpenSauced provides guidance for new contributors to find their next contribution. Our approach towards onboarding offers a way to track contributions through a GitHub-powered dashboard. +OpenSauced is a platform dedicated to empowering maintainers and teams and redefining the meaning of open source contributions. We believe that every contribution, big or small, is valuable and deserves to be recognized. Our platform provides a way to track contributions through a GitHub-powered dashboard, allowing users to showcase their contributions and gain insights into their open source projects. + +Our mission is to: + +- **Empower maintainers and teams**: Track and showcase your contributions and projects, connect with contributors, collaborate with your team, and gain insights into you open source projects. +- **Support Contributors**: Showcase your contributions, tell your story, connect with new projects and other contributors, and gain insights into your open source journey. +- [**Highlight Success**](../docs/features/highlights.md): Showcase your contributions with our Shareable Highlights, inspiring others to embark on their open-source journey. +- [**Unlock Insights**](../docs/features/insights.md): Understand the health of your project, track contributions, and make data-driven decisions with OpenSauced Insights. + diff --git a/docs/maintainers/setting-up-a-new-repository.md b/docs/maintainers/setting-up-a-new-repository.md deleted file mode 100644 index 9d180e8d..00000000 --- a/docs/maintainers/setting-up-a-new-repository.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -id: setting-up-a-new-repository -title: Setting up a new repository -sidebar_label: Setting up a new repository -keywords: - - setting up a new repository ---- - - -## Requirements - -For the purpose of this tutorial, our target demo repository will be called `open-sauced/npx-check-engines`. - -The steps described here mirror [open-sauced/check-engines](https://github.com/open-sauced/check-engines). - -The octoherd scripts assume you have exported a programmatic token similar to: - -```shell -export GH_TOKEN="ghp_Q8TZZT9ypgqw3EeABoCWPcwZBHpjZJ9hI42n" -``` - -## Creating a new repo - -Don't spend too much time thinking of a name or a catchy description, just set the license to MIT and rocket jump! - -![create a new repository](../../static/img/contributing-maintainers-create-repository.png) - -## Syncing settings with opensauced.pizza - -Squashing pull requests is the minimum requirement but the other options are quite useful at various stages of development. - -![minimum merge settings](../../static/img/contributing-maintainers-merge-settings.png) - -Copy most of the relevant settings with: - -```shell -npx octoherd-script-sync-repo-settings \ - --template "open-sauced/app" \ - -T $GH_TOKEN \ - -R "open-sauced/check-engines" -``` -Otherwise you can disable "Projects" and "Wikis" for the selected repository as we are handling them on a larger scale. - -## Syncing labels with opensauced.pizza - -The default labels have some missing emojis. Copy the rest with: - -```shell -npx octoherd-script-copy-labels \ - --template "open-sauced/open-sauced" \ - -T $GH_TOKEN \ - -R "open-sauced/check-engines" -``` -Then go back to your repository and delete: -- documentation -- πŸ‘€ needs-triage (green background one) -- other potential duplicates if the above race condition is different - -> In this context, `race condition` refers to a situation where multiple labels are being deleted simultaneously. This can cause issues if the order in which the labels are deleted affects the final outcome. Therefore, it's important to ensure that the deletion of labels is properly synchronized and controlled to avoid any race conditions. - -In other words, if two of the directories (e.g., `πŸ‘€ needs-triage` and `documentation` are deleted at the same, it is possible that the third directory(`potential duplicates`) will not be deleted. -To avoid the `race condition`, the code must delete the directories in a specific order. For example, it could delete the `documentation directory` first, then the `πŸ‘€ needs-triage` directory, and then the other `potential duplicates` directory. - -## Syncing branch protections with opensauced.pizza - -This topic is more complex but in a sense tap the main branch and enable -everything except "Restrict who can dismiss pull request reviews" and "Restrict who can push to matching branches" in the first section. - -![maximum merge protections](../../static/img/contributing-maintainers-merge-protections.png) - -The "Rules applied to everyone including administrators" is more of an unused override. - -Most of the time, this process is super manual, but in the limited cases where we need this run: - -```shell -npx @octoherd/script-sync-branch-protections \ - --template "open-sauced/open-sauced" \ - -T $GH_TOKEN \ - -R "open-sauced/check-engines" -``` - -## Setting up workflows - -Most collaborative projects require [compliance flows](https://github.com/open-sauced/open-sauced/blob/main/.github/workflows/compliance.yml) powered by [amannn/action-semantic-pull-request](https://github.com/amannn/action-semantic-pull-request) and [actions/first-interaction](https://github.com/actions/first-interaction). - -Pull requests require [triage](https://github.com/open-sauced/open-sauced/blob/main/.github/workflows/triage.yml) powered by [bdougie/take-action](https://github.com/bdougie/take-action). - -Most `node` projects will require [release automation](https://github.com/open-sauced/open-sauced/blob/main/.github/workflows/release.yml) powered by [@open-sauced/semantic-release-conventional-config](https://github.com/open-sauced/semantic-release-conventional-config). - -Other [development workflows](https://github.com/open-sauced/open-sauced/tree/main/.github/workflows) are less common and opinionated towards decentralized collaboration. Use these as examples of backbones for your new repository. - -## Setting up environments and secrets - -As you may have noticed in the previous step or in the action visualizations, the release workflows enable named environments. - -These have to be manually set up, along with their secrets and branch protections. - -![create environment](../../static/img/contributing-maintainers-env.png) - -If using `npm` or `ghcr`, it is likely you will add a couple of variables here. diff --git a/docs/maintainers/check-engines.md b/docs/opensauced-packages/check-engines.md similarity index 100% rename from docs/maintainers/check-engines.md rename to docs/opensauced-packages/check-engines.md diff --git a/docs/maintainers/conventional-commit.md b/docs/opensauced-packages/conventional-commit.md similarity index 100% rename from docs/maintainers/conventional-commit.md rename to docs/opensauced-packages/conventional-commit.md diff --git a/docs/maintainers/semantic-release.md b/docs/opensauced-packages/semantic-release.md similarity index 100% rename from docs/maintainers/semantic-release.md rename to docs/opensauced-packages/semantic-release.md diff --git a/docs/chrome-extension/code-explanation.md b/docs/tools/chrome-extension/code-explanation.md similarity index 84% rename from docs/chrome-extension/code-explanation.md rename to docs/tools/chrome-extension/code-explanation.md index 7afe4605..27951fc1 100644 --- a/docs/chrome-extension/code-explanation.md +++ b/docs/tools/chrome-extension/code-explanation.md @@ -9,4 +9,4 @@ keywords: Generate an explanation for a block of code by 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 the desired line. -![generate code refactor](../../static/gif/pr-code-explain.gif) +![generate code refactor](../../../static/gif/pr-code-explain.gif) diff --git a/docs/chrome-extension/highlights.md b/docs/tools/chrome-extension/highlights.md similarity index 100% rename from docs/chrome-extension/highlights.md rename to docs/tools/chrome-extension/highlights.md diff --git a/docs/chrome-extension/introduction-to-the-chrome-extension.md b/docs/tools/chrome-extension/introduction-to-the-chrome-extension.md similarity index 100% rename from docs/chrome-extension/introduction-to-the-chrome-extension.md rename to docs/tools/chrome-extension/introduction-to-the-chrome-extension.md diff --git a/docs/chrome-extension/pr-description.md b/docs/tools/chrome-extension/pr-description.md similarity index 98% rename from docs/chrome-extension/pr-description.md rename to docs/tools/chrome-extension/pr-description.md index febf2830..c8c5c342 100644 --- a/docs/chrome-extension/pr-description.md +++ b/docs/tools/chrome-extension/pr-description.md @@ -11,7 +11,7 @@ This will help you to create a PR based on the configuration you have in the ext _Note: This feature is not available on private repositories._ -![generate pr description](../../static/gif/pr-description.gif) +![generate pr description](../../../static/gif/pr-description.gif) You can use this settings to set the strictness and the tone of the generated AI, here is an explanation of those settings: diff --git a/docs/chrome-extension/refactoring-and-testing.md b/docs/tools/chrome-extension/refactoring-and-testing.md similarity index 81% rename from docs/chrome-extension/refactoring-and-testing.md rename to docs/tools/chrome-extension/refactoring-and-testing.md index 0723ce92..1b0a0f5c 100644 --- a/docs/chrome-extension/refactoring-and-testing.md +++ b/docs/tools/chrome-extension/refactoring-and-testing.md @@ -9,8 +9,8 @@ keywords: Refactor a block of code by 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 the desired line. -![generate code refactor](../../static/gif/pr-code-refactor.gif) +![generate code refactor](../../../static/gif/pr-code-refactor.gif) Generate tests for a block of code by 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 the desired line. -![generate code refactor](../../static/gif/pr-code-test.gif) +![generate code refactor](../../../static/gif/pr-code-test.gif) diff --git a/docs/chrome-extension/viewing-insights-and-invitations.md b/docs/tools/chrome-extension/viewing-insights-and-invitations.md similarity index 73% rename from docs/chrome-extension/viewing-insights-and-invitations.md rename to docs/tools/chrome-extension/viewing-insights-and-invitations.md index b7225beb..80b93af3 100644 --- a/docs/chrome-extension/viewing-insights-and-invitations.md +++ b/docs/tools/chrome-extension/viewing-insights-and-invitations.md @@ -1,23 +1,23 @@ --- id: viewing-insights-and-invitations title: 'Viewing Insights and Invitations' -sidebar_label: Insights and Invitations' +sidebar_label: Insights and Invitations keywords: - github - insights and invitations --- View stats about open issues, PRs made, average PRs velocity, and contributed repos that are in the OpenSauced database. This page can be found by clicking the profile picture at the top left of the extension. -![GitHub Profile Insights](../../static/img/extension-popup.png) +![GitHub Profile Insights](../../../static/img/extension-popup.png) ### Invite GitHub users to join OpenSauced with a single click Invite other users to create an OpenSauced account to keep track of open source contributions when visiting their GitHub profile. -![Invite GitHub Users](../../static/img/extension-invite.png) +![Invite GitHub Users](../../../static/img/extension-invite.png) ### View GitHub users' OpenSauced profiles and connect with them View a user’s OpenSauced profile when on their GitHub profile page. -![View OpenSauced Profiles](../../static/img/extension-view.png) +![View OpenSauced Profiles](../../../static/img/extension-view.png) diff --git a/docs/community/hot-opensauced.md b/docs/tools/hot-opensauced.md similarity index 100% rename from docs/community/hot-opensauced.md rename to docs/tools/hot-opensauced.md diff --git a/docs/tools/pizza-cli.md b/docs/tools/pizza-cli.md new file mode 100644 index 00000000..432d2d0f --- /dev/null +++ b/docs/tools/pizza-cli.md @@ -0,0 +1,76 @@ +--- +id: pizza-cli +title: Introduction to the Pizza CLI +sidebar_label: Pizza CLI +keywords: + - introduction to the pizza CLI +--- + +## The OpenSauced Pizza CLI +The OpenSauced Pizza CLI is a command-line utility designed specifically for OpenSauced. It provides a comprehensive set of functionalities that make it easier for users to gain insights, metrics, and manage various tasks related to open source projects through OpenSauced. + +Beyond just code commits, the pizza CLI reports on different ways individuals contribute to the open-source ecosystem, be it through community engagement, issue reporting, blog post writings, or pull request creations. + +## Key Features + +- Bake: Seamlessly source git commits into OpenSauced with the metaphorical 'oven' of technology. +- Insights: Dive deep into data about git contributors, repositories, users, and pull requests. +- Repo-query: Get your questions answered about any GitHub repository. +- Show: Visualize the metrics of a repository, providing a holistic view of its health and activity. +- Login: Securely log into the application via GitHub, ensuring a streamlined and safe experience. + +## Installation and Instructions + +πŸ“¦ Download & Install +The pizza CLI provides multiple installation methods to cater to the varied preferences of its users: + +- Homebrew: For macOS users who prefer the Homebrew package manager: + +```bash +brew install open-sauced/tap/pizza +``` + +NPM: For those who are fond of the Node Package Manager: + +```bash +npm i -g pizza +``` + +Direct Script Install: A quick way to get started by directly fetching the installation script from GitHub: + +```bash +curl -fsSL https://raw.githubusercontent.com/open-sauced/pizza-cli/main/install.sh +``` +⚠️ Warning: Piping scripts directly from the web to your shell can be risky. Always ensure you trust the source. For a safer approach, download, inspect, and then execute: + +```bash +curl -fsSL https://raw.githubusercontent.com/open-sauced/pizza-cli/main/install.sh > install.sh +vim install.sh +./install.sh +``` +Manual Build and Install: For those who like a hands-on approach: + +```bash +make install +``` +Ensure /usr/local/bin/ is in your path with: + +```bash +export PATH="$PATH:/usr/local/bin" +``` +Alternatively, after building with make build, move the binary to your desired location: + +```bash +mv build/pizza +``` +### πŸ–₯️ Local Development Setup +To contribute to or modify the pizza CLI, you need a specific set of tools: + +- Go Toolchain: The foundational tool for building and managing Go applications. +- Docker: Required for linting and other auxiliary tooling. +- Make: A build automation tool. +Development Commands: + +- Linting: Ensure code quality with make lint. +- Testing: Verify functionality with make test. +- Building: Create the executable with make build. \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 2dbe49f9..635dd7b9 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -77,20 +77,20 @@ module.exports = { style: "dark", links: [ { - title: "Docs", + title: "Learn", items: [ { label: "Contributing guide", to: "/contributing/introduction-to-contributing/", }, - { - label: "Maintainer guide", - to: "/maintainers/setting-up-a-new-repository/", - }, { label: "Chrome Extension Usage", - to: "/chrome-extension/introduction-to-the-chrome-extension/", + to: "/tools/chrome-extension/introduction-to-the-chrome-extension/", }, + { + label: "Your Open Source Resume", + to: "https://intro.opensauced.pizza/#/06-the-secret-sauce?id=develop-your-open-source-resume", + } ], }, { @@ -105,8 +105,8 @@ module.exports = { href: "https://discord.com/invite/U2peSNf23P", }, { - label: "Twitter", - href: "https://twitter.com/saucedopen", + label: "X", + href: "https://x.com/saucedopen", }, ], }, @@ -120,7 +120,11 @@ module.exports = { { label: "Download book", href: "https://docs.opensauced.pizza/open-sauced-docs.pdf", - }, + },{ + label: "Watch our feature demos", + href: "https://www.youtube.com/playlist?list=PLHyZ0Wz_A44VRlE-YS9me5qxDNRgK5T3H" + } + ], }, ], diff --git a/sidebars.js b/sidebars.js index 9eb4fba1..e2f5c4e9 100644 --- a/sidebars.js +++ b/sidebars.js @@ -14,103 +14,112 @@ module.exports = { "introduction", { type: "category", - label: "Getting started", + label: "Features", collapsed: false, items: [ - "community/welcome-to-the-community", - "community/100-days-of-oss", - "community/highlights", - "community/insights", - "community/faqs", - "community/dev-card", - "community/hacktoberfest", - "community/lists", - "community/connections", - "community/hot-opensauced", + "features/highlights", + "features/insights", + "features/dev-card", + "features/lists", + "features/connections", ], }, { type: "category", - label: "Contributing guide", + label: "Getting started", collapsed: false, items: [ - "contributing/introduction-to-contributing", - "contributing/code-of-conduct", - "contributing/triage-guide", - "contributing/set-up-authentication", + "community/welcome-to-the-community", + "community/100-days-of-oss", + "community/faqs", ], }, { type: "category", - label: "Technical guide", + label: "Tools", collapsed: false, items: [ - "technical/introduction-to-storybook", - "technical/setup-repo-with-git", - "technical/resolve-merge-conflicts", + "tools/hot-opensauced", + "tools/pizza-cli", + { + type: "category", + label: "Chrome Extension Usage", + collapsed: true, + items: [ + "tools/chrome-extension/introduction-to-the-chrome-extension", + { + type: "category", + label: "Using the Chrome Extension", + items: [ + { + type: "file", + label: "feature 1", + type: "doc", + id:"tools/chrome-extension/code-explanation", + }, + { + type: "file", + label: "feature 2", + type: "doc", + id: "tools/chrome-extension/pr-description", + }, + { + type: "file", + label: "feature 3", + type: "doc", + id: "tools/chrome-extension/highlights", + }, + { + type: "file", + label: "feature 5", + type: "doc", + id: "tools/chrome-extension/refactoring-and-testing", + }, + { + type: "file", + label: "feature 6", + type: "doc", + id: "tools/chrome-extension/viewing-insights-and-invitations", + }, + ], + }, + ], + }, ], }, { type: "category", - label: `Maintainer guide`, + label: "Contributing guide", collapsed: true, items: [ - "maintainers/maintainers-guide", - "maintainers/setting-up-a-new-repository", - "maintainers/check-engines", - "maintainers/conventional-commit", - "maintainers/semantic-release", + "contributing/introduction-to-contributing", + "contributing/code-of-conduct", + "contributing/triage-guide", + "contributing/set-up-authentication", + "contributing/maintainers-guide", + { + type: "category", + label: "Technical guide", + collapsed: true, + items: [ + "contributing/technical/introduction-to-storybook", + "contributing/technical/setup-repo-with-git", + "contributing/technical/resolve-merge-conflicts", + ], + }, ], }, + { type: "category", - label: "Chrome Extension Usage", + label: `OpenSauced Packages`, collapsed: true, items: [ - "chrome-extension/introduction-to-the-chrome-extension", - { - type: "category", - label: "Using the Chrome Extension", - items: [ - { - type: "file", - label: "feature 1", - type: "doc", - id: "chrome-extension/code-explanation", - }, - { - type: "file", - label: "feature 2", - type: "doc", - id: "chrome-extension/pr-description", - }, - { - type: "file", - label: "feature 3", - type: "doc", - id: "chrome-extension/highlights", - }, - { - type: "file", - label: "feature 4", - type: "doc", - id: "chrome-extension/opensauced-links", - }, - { - type: "file", - label: "feature 5", - type: "doc", - id: "chrome-extension/refactoring-and-testing", - }, - { - type: "file", - label: "feature 6", - type: "doc", - id: "chrome-extension/viewing-insights-and-invitations", - }, - ], - }, + "opensauced-packages/check-engines", + "opensauced-packages/conventional-commit", + "opensauced-packages/semantic-release", ], }, + ], };