Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!--
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whenever someone opens a PR in the docs repo, this will be in the PR description

Before submitting a pull request, please read:

For contributing a community toolkit, please use the [Community Contributed Toolkit Pull Request Template](https://github.com/ArcadeAI/docs/blob/main/.github/PULL_REQUEST_TEMPLATE/community_contributed_toolkit.md).
-->
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/community_contributed_toolkit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Add community toolkit "your-toolkit-name"

## Toolkit Checklist

- [ ] The toolkit is published to PyPI
- [ ] The toolkit source code is hosted in a publicly accessible repository on a supported version control platform (e.g., GitHub, GitLab, etc.)
- [ ] The toolkit is licensed under an open source license

## PR Checklist

- [ ] I have determined the appropriate category for the toolkit, e.g., `productivity`, `social-communication`, `entertainment`, `development`, `automation`, etc.
- [ ] I create a new file located at `pages/toolkits/<category>/my-toolkit-name.mdx` that uses the [Community Toolkit Template](https://github.com/ArcadeAI/docs/blob/main/pages/toolkits/community-toolkit-template.mdx)
Copy link
Member Author

@EricGustin EricGustin Feb 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this link will work once this PR is merged since we are adding that file in this PR

- [ ] I have added the toolkit to the `pages/toolkits/<category>/_meta.ts` file
- [ ] I have added the toolkit to the `src/components/custom/Toolkits/toolkits-config.ts` file. For the toolkit's image,
- [ ] I am using the default image `public/images/icons/community-contributed.png` OR
- [ ] I am using an image that is smaller than 5 KB that I have added at `public/images/icons/<image-name>.png`
14 changes: 14 additions & 0 deletions pages/toolkits/_meta.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ export default {
layout: "full",
},
},
"-- Categories": {
type: "separator",
title: "Categories",
},
productivity: {
title: "Productivity & Docs",
},
Expand All @@ -20,4 +24,14 @@ export default {
automation: {
title: "Automation",
},
"-- Submit your toolkit": {
type: "separator",
title: "Submit your toolkit",
},
"contribute-a-toolkit": {
title: "Contribute a toolkit",
},
"community-toolkit-template": {
display: "hidden",
},
};
3 changes: 3 additions & 0 deletions pages/toolkits/community-toolkit-template.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Arcade <toolkit-name> Toolkit

The Arcade <toolkit-name> Toolkit is a community contributed toolkit meaning that it is created and maintained by the community. To learn more about the toolkit, please visit the [Arcade <toolkit-name> GitHub repository](https://github.com/<github-username>/<repo-name>).
18 changes: 18 additions & 0 deletions pages/toolkits/contribute-a-toolkit.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# How to contribute a toolkit

Arcade welcomes your toolkit contributions. By adding your toolkit to the Arcade documentation, you help other developers discover and use your tools. Follow these steps to submit your own toolkit.

## Prerequisites

- Build your toolkit. See [build a toolkit](home/build-tools/create-a-toolkit) for guidance.
- Publish your toolkit on PyPI.

## Submit your toolkit
Open a pull request in the [Arcade Documentation GitHub repository](https://github.com/ArcadeAI/docs) that completes the [community toolkit checklist](https://github.com/ArcadeAI/docs/blob/main/.github/PULL_REQUEST_TEMPLATE/community_contributed_toolkit.md). The checklist will guide you through the necessary steps to ensure your toolkit contribution is successful.

## Review and merge

After submitting your pull request:
- Double-check all checklist items have been completed.
- Address any feedback from the reviewers.
- Once approved, your toolkit will be added to the Arcade documentation for other developers to discover and use!