mirror of
https://github.com/rowboatlabs/rowboat.git
synced 2026-05-25 18:55:19 +02:00
Mintlify docs (#217)
* add the new docs * Update to latest comprehensive docs from mintlify2 branch - Add conversations, jobs, triggers guides - Complete tools documentation - Enhanced RAG and agents docs - Add UI screenshots and images - Update contribution guide and quickstart * added intro gif * Update introduction.mdx with intro gif * Add public/videos folder with Intro-Video.gif for proper Next.js/Mintlify serving * updated gif * Update introduction.mdx to have a working intro gif
This commit is contained in:
parent
8f40b5fb33
commit
daaac23f76
45 changed files with 1972 additions and 0 deletions
59
apps/docs/docs/development/contribution-guide.mdx
Normal file
59
apps/docs/docs/development/contribution-guide.mdx
Normal file
|
|
@ -0,0 +1,59 @@
|
|||
---
|
||||
title: "Contribution Guide"
|
||||
description: "Learn how to contribute to the Rowboat project and help improve our platform."
|
||||
icon: "github"
|
||||
---
|
||||
|
||||
# Join the Rowboat Voyage
|
||||
|
||||
We're building Rowboat as an open-source, community-powered platform — and we'd love for you to hop aboard! Whether you're fixing typos, suggesting a new tool integration, or designing your dream multi-agent workflow, your contributions are valuable and welcome.
|
||||
|
||||
<Frame>
|
||||
<img src="/docs/img/contribution-guide-hero.png" className="w-full max-w-[600px] rounded-xl" alt="Contribution guide hero image showing community collaboration" />
|
||||
</Frame>
|
||||
|
||||
---
|
||||
|
||||
## How You Can Contribute
|
||||
|
||||
|
||||
- **Tackle Open Issues**
|
||||
Browse our [GitHub Issues](https://github.com/rowboatlabs/rowboat/issues) for tags like `good first issue`, `help wanted`, or `bug` to find a spot that fits your skillset.
|
||||
|
||||
- **Join the Community**
|
||||
Our [Discord](https://discord.gg/PCkH9TWC) is the go-to hub for brainstorming, feedback, and finding contributors for bigger efforts.
|
||||
|
||||
- **Propose Something New**
|
||||
Have a new tool integration idea or found a bug? Open an issue and let’s discuss it!
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Contribution Workflow & Best Practices
|
||||
|
||||
Whether it's your first contribution or your fiftieth, here's what a great contribution looks like:
|
||||
|
||||
| Step / Tip | Description |
|
||||
|-------------------------------|-----------------------------------------------------------------------------------------------|
|
||||
| **1. Fork the Repository** | Create a personal copy of [rowboatlabs/rowboat](https://github.com/rowboatlabs/rowboat) to start contributing. |
|
||||
| **2. Create a New Branch** | Use a descriptive name like `fix-tool-crash` or `feature-new-mcp`. Avoid committing to `main`. |
|
||||
| **3. Make Your Changes** | Focus your PR on a single issue or feature to keep things clean and reviewable. |
|
||||
| **4. Write Tests if Needed** | If you change logic, add relevant tests so your contribution is future-proof. |
|
||||
| **5. Run Tests & Lint Locally**| Make sure your branch passes all tests and code quality checks before pushing. |
|
||||
| **6. Document or Demo It** | Add helpful context: screenshots, example scripts, or a short video/gif to demonstrate your changes. |
|
||||
| **7. Submit a Pull Request** | Open a PR with a clear description of your changes and any context reviewers should know. |
|
||||
| **8. Collaborate on Feedback** | Our maintainers may leave comments — it’s all part of the process. Let’s improve it together. |
|
||||
| **9. Don’t Be Shy to Follow Up** | Feel free to ping the PR/issue if you're waiting on feedback. We appreciate polite nudges. |
|
||||
| **10. Celebrate the Merge!** | You just made Rowboat better. Thanks for contributing 🚀 |
|
||||
|
||||
<Tip>If you're fixing typos, spacing, or small tweaks — try bundling those into a related PR instead of sending them standalone. It helps keep reviews focused. </Tip>
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Come Build With Us
|
||||
|
||||
We believe great ideas come from the community — and that means **you**. Whether you're an engineer, designer, AI tinkerer, or curious beginner, there’s room on this boat for everyone.
|
||||
|
||||
Let’s build the future of AI workflows — together. 🫶
|
||||
7
apps/docs/docs/development/roadmap.mdx
Normal file
7
apps/docs/docs/development/roadmap.mdx
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
icon: "road"
|
||||
---
|
||||
|
||||
# Roadmap
|
||||
|
||||
Explore the future development plans and upcoming features for Rowboat.
|
||||
Loading…
Add table
Add a link
Reference in a new issue