BarnacleBoy
|
a223bcb27a
|
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
|
2026-04-18 22:58:33 +00:00 |
|
BarnacleBoy
|
7b4e280a3d
|
Update documentation for APIClient.wrapped and WRAPPERS.md
- Fixed APIClient.wrapped() doc to use job_function instead of job
- Updated WRAPPERS.md parameter tables:
- update_post(): Corrected all parameters (post_text, post_path, parent_path, post_key, blur_label, card_url, collaborative)
- create_comment(): Made parent_path optional, added comment_text requirement, clarified post_slug/post_key alternatives
# Conflicts:
# docs/WRAPPERS.md
|
2026-04-18 03:44:21 +00:00 |
|
Jezza Hehn
|
4f0c06771d
|
docs: fix WRAPPERS.md replacement examples
- update_post wrapper example now uses correct parameters (post_text, post_path)
- create_comment wrapper example shows post_key parameter option
|
2026-04-18 02:59:16 +00:00 |
|
Jezza Hehn
|
e7cf4f1e09
|
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)
|
2026-04-18 02:47:33 +00:00 |
|
BarnacleBoy
|
fd1a1566e9
|
chore: add comprehensive API wrapper documentation
- Add docs/ directory with 6 comprehensive documentation files:
* INDEX.md - Main navigation and documentation index
* GETTING_STARTED.md - Setup and configuration guide
* API_REFERENCE.md - Complete API documentation
* WRAPPERS.md - High-level wrappers guide
* CUSTOM_REQUESTS.md - Advanced usage patterns
* TROUBLESHOOTING.md - Problem-solving guide
- Update README.md with enhanced project information
- Update development.md with expanded documentation context
Extends previous session's documentation work with complete
developer and user-facing documentation.
Closes previous documentation issue.
|
2026-04-18 02:35:56 +00:00 |
|