docs: fix parameter mismatches and inaccurate documentation

- Fix update_post() wrapper documentation (post_id -> post_text/post_path/post_key)
- Fix create_comment() wrapper documentation (added post_slug, post_key parameters)
- Add missing wrapper docs for follow(), trust(), votecast(), react()
- Fix reaction job parameters (parent_id -> parent_sk, corrected payload structure)
- Fix trust job parameters (updated to match actual payload structure)
- Fix vote job parameters (voteType -> vote, added parent structure)
- Clearly mark Block and Mute jobs as NOT IMPLEMENTED
- Fix GitLab URLs to Forgejo (git.jezzahehn.com)
- Remove LLM-style language (comprehensive -> full/thorough)
- Fix trust listbyusersinit parameter (username -> user_id)
This commit is contained in:
Jezza Hehn 2026-04-18 02:47:33 +00:00
parent fd1a1566e9
commit e7cf4f1e09
6 changed files with 320 additions and 95 deletions

View file

@ -118,7 +118,7 @@ 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)
4. **File an issue on Forgejo** - [Repository Issues](https://git.jezzahehn.com/KrustyPlanet/trustcafe-api-wrapper/issues)
---
@ -128,7 +128,7 @@ Document version updates should be listed here.
### v0.2.0 (Current)
- Complete rewrite and enhancement of all documentation
- Added comprehensive API reference
- Added full API reference
- Added wrappers guide
- Added custom requests guide
- Added detailed troubleshooting section
@ -159,4 +159,4 @@ When contributing documentation remember:
---
**Last Updated:** April 17, 2026
**Last Updated:** April 18, 2026