TaskadeChangelogDocumentation

Contributing

This documentation is open source and we welcome contributions from the community. Whether you're fixing a typo, adding examples, or writing new sections, your help makes these docs better for everyone.

🚀 Quick Start

1. Fork the Repository

Visit https://github.com/taskade/docs and click "Fork" to create your own copy.

2. Clone Your Fork

git clone https://github.com/YOUR_USERNAME/docs.git
cd docs

3. Make Your Changes

Edit the markdown files using your preferred editor. All documentation is written in standard Markdown.

4. Test Your Changes

Preview your changes locally if possible, or check that links work and formatting is correct.

5. Submit a Pull Request

Push your changes and create a pull request with a clear description of what you've improved.

📝 What You Can Contribute

Documentation Improvements

  • Fix typos and grammatical errors

  • Improve clarity and readability

  • Add missing information

  • Update outdated content

Code Examples

  • Add practical code examples

  • Improve existing examples

  • Add examples for different programming languages

  • Create complete workflow examples

Integration Documentation

  • Document new integrations

  • Add setup guides for specific tools

  • Share automation recipes

  • Create troubleshooting guides

Visual Content

  • Create diagrams and flowcharts

  • Add screenshots for setup guides

  • Design infographics for complex concepts

  • Improve existing visual content

📋 Contribution Guidelines

Writing Style

  • Use clear, concise language

  • Write for developers of all skill levels

  • Include practical examples

  • Use active voice when possible

  • Keep sentences and paragraphs short

Code Examples

  • Include complete, working examples

  • Add comments to explain complex logic

  • Use realistic data in examples

  • Test all code examples before submitting

Formatting

  • Use proper Markdown syntax

  • Include code language tags for syntax highlighting

  • Use consistent heading levels

  • Add line breaks for readability

Links and References

  • Use relative links for internal documentation

  • Verify all external links work

  • Include relevant help center articles

  • Add links to related API endpoints

🗂️ Documentation Structure

Main Sections

  • vision/ - High-level vision and architecture

  • genesis/ - No-code creation platform

  • taskos/ - AI App Generator documentation

  • automation/ - Automation engine and integrations

  • api/ - API reference and guides

  • start/ - Getting started guides

File Naming

  • Use lowercase with hyphens: my-new-guide.md

  • Be descriptive: github-integration-setup.md

  • Group related files in folders

  • Use README.md for section overviews

Content Organization

  • Start with overview and use cases

  • Include step-by-step instructions

  • Add troubleshooting sections

  • End with related resources

🔄 Review Process

Automated Checks

All pull requests are automatically checked for:

  • Markdown formatting

  • Link validity

  • Spelling and grammar

  • Code example syntax

Manual Review

Our team reviews contributions for:

  • Technical accuracy

  • Clarity and usefulness

  • Consistency with existing docs

  • Completeness of examples

Feedback and Iteration

  • We'll provide constructive feedback

  • Multiple rounds of review are normal

  • We're here to help improve your contribution

  • Don't be discouraged by change requests

🏆 Recognition

Contributors

All contributors are recognized in our:

  • GitHub contributors list

  • Documentation changelog

  • Community highlights

  • Annual contributor awards

Community Champions

Outstanding contributors may be invited to:

  • Join our documentation team

  • Participate in early feature previews

  • Speak at Taskade events

  • Collaborate on special projects

🎯 Priority Areas

We especially welcome contributions in these areas:

High Priority

  • Automation recipes and examples

  • Integration setup guides

  • Troubleshooting documentation

  • API usage examples

Medium Priority

  • Visual diagrams and flowcharts

  • Video tutorials and walkthroughs

  • Community-requested features

  • Performance optimization guides

Ongoing Needs

  • Keeping examples up-to-date

  • Fixing broken links

  • Improving search functionality

  • Translation to other languages

🐛 Reporting Issues

Found a Problem?

If you find issues but can't fix them yourself:

  1. Check existing issues at github.com/taskade/docs/issues

  2. Create a new issue with:

    • Clear description of the problem

    • Steps to reproduce (if applicable)

    • Suggested solution (if you have one)

    • Screenshots or examples

Issue Labels

  • bug - Something is broken

  • enhancement - Improvement suggestion

  • documentation - Documentation issue

  • good first issue - Good for new contributors

  • help wanted - We need community help

💡 Suggesting New Content

Content Requests

To suggest new documentation:

  1. Check the roadmap in our issues

  2. Create a content request with:

    • What should be documented

    • Why it's important

    • Who would benefit

    • Outline or structure ideas

Popular Requests

Current community requests include:

  • More automation examples

  • Integration troubleshooting

  • Advanced API usage patterns

  • Performance optimization guides

🛠️ Technical Setup

Local Development

For advanced contributors who want to preview changes:

# Install GitBook CLI (optional)
npm install -g gitbook-cli

# Serve documentation locally
gitbook serve

# Build static site
gitbook build

Markdown Extensions

We support standard Markdown plus:

  • Code syntax highlighting

  • Mermaid diagrams

  • Table formatting

  • Emoji shortcodes

📞 Getting Help

Community Support

Direct Contact

📜 License

By contributing to this documentation, you agree that your contributions will be licensed under the same license as the project.

🙏 Thank You

Every contribution, no matter how small, helps make Taskade better for everyone. We're grateful for your time and effort in improving our documentation.

Ready to contribute? → Browse open issues

Have questions? → Join our community

Want to suggest new content? → Create a content request

PreviousGet Projects

Last updated