# TrustCafé API Wrapper - Documentation Index

Complete documentation for the TrustCafé API wrapper.

## Getting Started

**New to the wrapper?** Start here.

- [Getting Started Guide](GETTING_STARTED.md) - Complete setup and configuration guide
- [README.md](../README.md) - Overview package information and installation

## Core Usage

**Learn how to use the API wrapper effectively.**

- [Wrappers Guide](WRAPPERS.md) - High-level wrappers for common operations
- [API Reference](API_REFERENCE.md) - Complete API job reference
- [Custom Requests Guide](CUSTOM_REQUESTS.md) - Making advanced API calls manually

## Development

**Contributing or extending the wrapper.**

- [Development Guide](../development.md) - Development notes, design decisions, and known limitations
- [Examples](../README.md#examples) - Real-world usage examples

## Support and Troubleshooting

**Having issues?** Find solutions here.

- [Troubleshooting Guide](TROUBLESHOOTING.md) - Common issues and solutions

---

## Quick Links

### For New Users
1. [Installation](../README.md#installation)
2. [Authentication Setup](GETTING_STARTED.md#api-credentials-setup)
3. [First API Call](GETTING_STARTED.md#first-api-call)
4. [Basic Usage](../README.md#quick-start)

### For In-Depth Learning
1. [Wrappers](WRAPPERS.md) - Start here for easiest usage
2. [API Reference](API_REFERENCE.md) - Deep dive into all jobs
3. [Creating Custom Wrappers](WRAPPERS.md#creating-custom-wrappers)

### For Developers
1. [Extending the Wrapper](../development.md#extending-the-wrapper)
2. [Testing Guide](../development.md#testing-guide)
3. [Contributing](../development.md#contributing)
4. [Known Limitations](../development.md#known-limitations)

---

## Documentation Contents

### Getting Started (GETTING_STARTED.md)
- Installation steps
- API credentials setup
- Environment configuration
- First API call example
- Token management best practices
- Setup patterns for different environments

### Wrappers Guide (WRAPPERS.md)
- Overview of wrapper system
- Post wrapper documentation (create_post, update_post)
- Comment wrapper documentation (create_comment)
- Wrapper best practices
- Wrapper vs Job comparison
- Creating custom wrappers

### API Reference (API_REFERENCE.md)
- All available Jobs
- Complete job parameters and return values
- Authentication job documentation
- Post, Comment, UserProfile, Follow, Vote jobs
- Reaction, Notification, Trust, Branch jobs
- Feed operations
- Error handling patterns
- Pagination guide

### Custom Requests Guide (CUSTOM_REQUESTS.md)
- Using the `make_request` method
- Advanced usage patterns
- Pagination strategies
- Batch operations
- Error handling for custom calls
- Complex query examples

### Troubleshooting Guide (TROUBLESHOOTING.md)
- Authentication issues
- Connection problems
- Token management errors
- API call issues
- Environment issues
- Data handling problems
- Performance issues
- Debugging strategies

### Development Guide (development.md)
- Project structure
- Design decisions and debates
- Known limitations
- Missing features
- Future enhancements
- Contributing guidelines
- Testing guide
- Extension instructions

---

## Support

If you can't find the answer you're looking for:

1. **Check the FAQs section** - Common questions and answers
2. **Review the Troubleshooting guide** - For specific error handling
3. **Contact WikiTribune team** - Via company channels
4. **File an issue on GitLab** - [Repository Issues](https://gitlab.com/trustcafe/trustcafe-api-wrapper/-/issues)

---

## Changelog

Document version updates should be listed here.

### v0.2.0 (Current)
- Complete rewrite and enhancement of all documentation
- Added full API reference
- Added wrappers guide
- Added custom requests guide
- Added detailed troubleshooting section
- Enhanced development documentation
- Improved README.md structure and examples

### v0.1.0.13
- Initial release with basic documentation
- Minimum set of jobs and wrappers

---

## Contributing to Documentation

If you find any documentation issues:

1. **Typos or errors** - Correct in the markdown file
2. **Outdated examples** - Update with correct code
3. **Missing information** - Add to the appropriate section
4. **Unclear explanations** - Improve wording for clarity

When contributing documentation remember:
- Keep examples working
- Maintain consistent formatting
- Use proper markdown syntax
- Link to related documentation
- Update this INDEX.md if structure changes

---

**Last Updated:** April 18, 2026