Skip to content

Support Resources

Jump to bottom
Mo Abualruz edited this page Dec 12, 2025 · 3 revisions

Support Resources

Status: ✅ Complete

Last Updated: December 5, 2025

Overview

This page provides information about getting support for RiceCoder, including documentation, community channels, and contact information.

Table of Contents

Documentation

Quick References

Feature Documentation

Advanced Topics

Troubleshooting

Community Support

GitHub Discussions

Purpose: Ask questions, discuss ideas, and get community support

How to Use:

  1. Visit GitHub Discussions
  2. Click "New Discussion"
  3. Choose appropriate category
  4. Describe your question or topic
  5. Wait for community responses

Categories:

  • Q&A: Ask questions and get answers
  • Ideas: Discuss feature ideas and suggestions
  • Show and Tell: Share your projects and creations
  • Announcements: Important announcements and updates

Response Time: Usually 24-48 hours

GitHub Issues

Purpose: Report bugs and request features

How to Report a Bug:

  1. Visit GitHub Issues
  2. Click "New Issue"
  3. Choose "Bug Report" template
  4. Fill in the template with details
  5. Submit the issue

How to Request a Feature:

  1. Visit GitHub Issues
  2. Click "New Issue"
  3. Choose "Feature Request" template
  4. Describe the feature and use case
  5. Submit the issue

Response Time: Usually 1-3 days

Discord Community

Purpose: Real-time chat and community support

How to Join:

  1. Click Discord Invite Link
  2. Accept the invite
  3. Read the rules and guidelines
  4. Introduce yourself in #introductions
  5. Start chatting!

Channels:

  • #general: General discussion
  • #help: Get help from the community
  • #announcements: Important announcements
  • #showcase: Share your projects
  • #development: Development discussions
  • #bugs: Report bugs
  • #features: Request features

Response Time: Usually 1-2 hours

GitHub Security Advisories

Purpose: Private or sensitive security issues

Link: GitHub Security Advisories

When to Use:

  • Security vulnerabilities
  • Private security concerns
  • Sensitive security information
  • Formal inquiries

Response Time: Usually 1-2 business days

Reporting Issues

Before Reporting

  1. Check Documentation: Search the wiki for answers
  2. Check FAQ: Look for your question in the FAQ
  3. Check Troubleshooting: See if your issue is documented
  4. Search Issues: Look for existing issues
  5. Search Discussions: Look for existing discussions

How to Report a Bug

Include:

  • Clear, descriptive title
  • Detailed description of the issue
  • Steps to reproduce
  • Expected vs actual behavior
  • System information (OS, version, etc.)
  • Error messages and logs
  • Screenshots if applicable

Example:

Title: Code completion crashes with syntax errors

Description:
When I open a file with syntax errors, code completion crashes
and RiceCoder becomes unresponsive.

Steps to Reproduce:
1. Create a Rust file with syntax errors
2. Enable code completion
3. Try to get completions

Expected: Graceful error handling
Actual: RiceCoder crashes

Environment:
- OS: macOS 12.0
- RiceCoder: v0.1.6
- Rust: 1.75.0

Error Message:
thread 'main' panicked at 'index out of bounds'

How to Request a Feature

Include:

  • Clear, descriptive title
  • Use case and motivation
  • Detailed description of the feature
  • Examples of how it would be used
  • Alternative solutions considered

Example:

Title: Add support for custom code formatters

Use Case:
I want to use a custom code formatter specific to my project.

Description:
Allow users to configure custom code formatters in .agent/config.yaml
that will be used instead of the default formatter.

Example:
```yaml
formatters:
  rust: "my-custom-formatter"

Alternatives:

  • Use environment variables
  • Use command-line flags

---

## Getting Help

### For Different Situations

| Situation | Best Channel | Response Time |
|-----------|--------------|----------------|
| Quick question | Discord #help | 1-2 hours |
| Detailed question | GitHub Discussions | 24-48 hours |
| Bug report | GitHub Issues | 1-3 days |
| Feature request | GitHub Issues | 1-3 days |
| Security issue | Email | 1-2 business days |
| Private concern | Email | 1-2 business days |

### Asking Good Questions

1. **Be Specific**: Provide clear, specific details
2. **Provide Context**: Explain what you're trying to do
3. **Include Examples**: Show code or configuration examples
4. **Describe What You've Tried**: Show what you've already attempted
5. **Be Patient**: Wait for responses and be respectful

### Getting Faster Responses

1. **Search First**: Check if your question is already answered
2. **Provide Details**: Include all relevant information
3. **Be Clear**: Use clear language and formatting
4. **Be Respectful**: Be polite and professional
5. **Follow Up**: Provide additional information if asked

---

## FAQ

### Installation

**Q: How do I install RiceCoder?**

A: See [Installation & Setup](./Installation-Setup.md) for detailed instructions.

Quick install:
```bash
cargo install ricecoder

Q: What are the system requirements?

A: See Installation & Setup for system requirements.

Configuration

Q: How do I set up my API key?

A: Use the rice config command:

rice config set api-key YOUR_API_KEY

Or set the environment variable:

export RICECODER_API_KEY=YOUR_API_KEY

Q: How do I switch between AI providers?

A: Use the rice config command:

rice config set provider openai
rice config set model gpt-4

Usage

Q: How do I start using RiceCoder?

A: See Quick Start Guide for a quick walkthrough.

Q: How do I generate code from a specification?

A: See Spec-Driven Development Guide for detailed instructions.

Troubleshooting

Q: I get "API key not found" error

A: See Troubleshooting Guide for solutions.

Q: RiceCoder is running slowly

A: See Troubleshooting Guide for performance tips.

More Questions?

See FAQ for more frequently asked questions.

Troubleshooting

Common Issues

Issue Solution
API key not recognized Check configuration, regenerate API key
Connection timeout Check network, verify provider is online
Code generation errors Review spec, provide more context
Performance is slow Use local models, reduce context size
Chat not responding Check network, verify API quota

Getting Help with Issues

  1. Check Troubleshooting Guide: Troubleshooting Guide
  2. Check FAQ: FAQ
  3. Search Discussions: GitHub Discussions
  4. Ask on Discord: Discord #help
  5. Report Issue: GitHub Issues

Contact Information

Support Channels

Channel Purpose Response Time
Discord Real-time chat 1-2 hours
GitHub Discussions Questions and ideas 24-48 hours
GitHub Issues Bugs and features 1-3 days
Email Private/sensitive 1-2 business days

Links

Social Media

Community Resources

Learning Resources

Community Contributions

Project Information

Feedback and Suggestions

We value your feedback! Please share:

See Also

Last updated: December 5, 2025

Clone this wiki locally