Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Add Comprehensive Documentation for SDK and Webhook Usage #5

Merged
merged 1 commit into from
Dec 2, 2024

Conversation

shiningflash
Copy link
Owner

Changes Included

  • Enhanced readme.md with project overview, setup guide, and usage details.
  • Added docs/sdk_usage.md with a detailed guide for SDK usage.
  • Added docs/webhook_guide.md with a comprehensive guide for webhook functionality.

Why These Changes?

  • To provide developers with clear, robust, and user-friendly documentation.
  • Align the project with best practices for documentation and usability.

How to Review

  • Review readme.md for overall project setup and usage.
  • Review docs/sdk_usage.md for detailed SDK usage.
  • Review docs/webhook_guide.md for webhook instructions.

Copy link

github-actions bot commented Dec 2, 2024

Coverage

Coverage Report
FileStmtsMissCoverMissing
src/sdk
   __init__.py00100% 
   client.py390100% 
src/sdk/features
   __init__.py00100% 
   contacts.py380100% 
   messages.py3022 93%
src/sdk/schemas
   __init__.py00100% 
   contacts.py1811 94%
   messages.py170100% 
src/sdk/utils
   __init__.py00100% 
   exceptions.py5299 83%
   logger.py220100% 
   requests.py1544 73%
   retry.py2111 95%
   validators.py6222 97%
src/server
   __init__.py00100% 
   app.py2533 88%
   schemas.py70100% 
TOTAL3462294% 

Tests Skipped Failures Errors Time
56 0 💤 0 ❌ 0 🔥 6.832s ⏱️

@shiningflash shiningflash added the documentation Improvements or additions to documentation label Dec 2, 2024
@shiningflash shiningflash merged commit 1366fdb into develop Dec 2, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant