Expand documentation with comprehensive usage guide and contributing guidelines - #159
Merged
Merged
Conversation
The migration guide told users that `include_unavailable`, `availability` and `delivery_flags` were gone, when the Creators API accepts all three, imported `get_asin` from a private path and listed only part of the exceptions of the module. The accepted values of `version`, the countries and the marketplace each one maps to, and the `marketplace` argument had no documentation at all, so the only way to find them was to read the code. The usage guide and the README had also drifted apart, each one holding sections the other lacked, and both promised the same methods in the two clients without telling that `close` only exists in the synchronous one. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HkMXgQgzMKJBkEE7Cw3jLi
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR significantly expands the project documentation to provide comprehensive guidance for both users and contributors. The changes include a detailed usage guide covering all client features, configuration options, and error handling, along with a new contributing guide for developers.
Key Changes
Documentation Improvements
Expanded usage guide (
docs/pages/usage-guide.md): Transformed from a basic overview into a comprehensive reference covering:Updated README.md: Aligned with the expanded usage guide, including:
New CONTRIBUTING.md: Added comprehensive contributor guide including:
uvDocumentation Structure Updates
Enhanced Sphinx configuration (
docs/conf.py):Improved RST documentation files:
docs/index.rst: Added introductory example and support sectiondocs/amazon_creatorsapi.rst: Clarified main API module purposedocs/amazon_creatorsapi.aio.rst: Added usage examples for async clientdocs/amazon_creatorsapi.core.rst: Documented core utilitiesdocs/amazon_creatorsapi.errors.rst: Explained error hierarchydocs/amazon_creatorsapi.models.rst: Clarified model re-exportsMigration Guide Updates
Minor Fixes
Notable Details
https://claude.ai/code/session_01HkMXgQgzMKJBkEE7Cw3jLi