a223bcb27a
- env= -> environment= across all docs (Pydantic silently ignores env=) - Remove __version__ check (doesn't exist in module) - Fix APIClient(debug=True) missing required client_id/secret - Fix post.listremoved usage (takes no postId, just lists removed posts) - Fix JS true/false -> Python True/False in code blocks - Fix parameter names: branchName->branch_slug, username->user_slug, postId->post_id - Add missing lastEvaluatedKey param docs for list jobs - Note post.listpublic as unauthenticated endpoint - Fix pagination examples (LastEvaluatedKey, not ExclusiveStartKey dict) - Remove non-existent headers param from make_request example - Fix branch.listbyname example (takes no name arg) - Add 4 missing wrapper docs: follow, react, trust, votecast - Fix broken internal links (case-sensitive filenames) - Fix <environment>_handle_token template artifact - Add CODE_BUGS.md documenting 4 code bugs found during audit
4.6 KiB
4.6 KiB
TrustCafé API Wrapper - Documentation Index
Complete documentation for the TrustCafé API wrapper.
Getting Started
New to the wrapper? Start here.
- Getting Started Guide - Complete setup and configuration guide
- README.md - Overview package information and installation
Core Usage
Learn how to use the API wrapper effectively.
- Wrappers Guide - High-level wrappers for common operations
- API Reference - Complete API job reference
- Custom Requests Guide - Making advanced API calls manually
Development
Contributing or extending the wrapper.
- Development Guide - Development notes, design decisions, and known limitations
- Examples - Real-world usage examples
Support and Troubleshooting
Having issues? Find solutions here.
- Troubleshooting Guide - Common issues and solutions
Quick Links
For New Users
For In-Depth Learning
- Wrappers - Start here for easiest usage
- API Reference - Deep dive into all jobs
- Creating Custom Wrappers
For Developers
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)
- Interaction wrappers (follow, react, trust, votecast)
- 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_requestmethod - 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:
- Check the FAQs section - Common questions and answers
- Review the Troubleshooting guide - For specific error handling
- Contact WikiTribune team - Via company channels
- File an issue on GitLab - Repository Issues
Changelog
Document version updates should be listed here.
v0.2.0 (Current Documentation)
- Complete rewrite and enhancement of all documentation
- Added full API reference
- Added wrappers guide (including follow, react, trust, votecast)
- Added custom requests guide
- Added detailed troubleshooting section
- Enhanced development documentation
- Improved README.md structure and examples
v0.1.0.13 (Package Version / Initial Release)
- Initial release with basic documentation
- Minimum set of jobs and wrappers
Contributing to Documentation
If you find any documentation issues:
- Typos or errors - Correct in the markdown file
- Outdated examples - Update with correct code
- Missing information - Add to the appropriate section
- 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