doc: audit pass — fix env= bug, params, pagination, missing wrappers, broken examples
- 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
This commit is contained in:
parent
c8611a7b88
commit
a223bcb27a
9 changed files with 552 additions and 247 deletions
|
|
@ -67,6 +67,7 @@ Complete documentation for the TrustCafé API wrapper.
|
|||
- 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
|
||||
|
|
@ -126,16 +127,16 @@ If you can't find the answer you're looking for:
|
|||
|
||||
Document version updates should be listed here.
|
||||
|
||||
### v0.2.0 (Current)
|
||||
### v0.2.0 (Current Documentation)
|
||||
- Complete rewrite and enhancement of all documentation
|
||||
- Added full API reference
|
||||
- Added wrappers guide
|
||||
- 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
|
||||
### v0.1.0.13 (Package Version / Initial Release)
|
||||
- Initial release with basic documentation
|
||||
- Minimum set of jobs and wrappers
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue