restructure jenkins pipeline for branch-based deployment

[the-khiem7]

This pull request updates the CI pipeline in Jenkinsfile and significantly revises the snake detection API usage guide documentation. The pipeline changes clarify and separate build and publish steps for different branch and PR scenarios, while the documentation is streamlined by removing inline JavaScript examples and updating the API response to reflect the latest schema, providing clearer descriptions of key fields.

CI/CD Pipeline Improvements

• Refactored Jenkins pipeline stages for clearer separation of build and publish steps:
  • Added distinct stages: Build Check (PR to dev), Publish Dev (Merged to dev), Publish Preview (PR to main), and Publish Latest (Merged to main). Each stage now has precise conditions and cleanup steps, improving clarity and maintainability. [1] [2]
• Improved Docker image tagging and registry handling:
  • Preview images use the preview-<PR_ID> tag, and dev images use the dev tag. The cleanup logic is standardized across stages. [1] [2]
• Minor code comment cleanup in Docker build argument function.

Documentation Simplification and Updates

• Removed all inline JavaScript usage examples and React integration code from the snake detection usage guide, streamlining the documentation for easier maintenance and less clutter. [1] [2] [3]
• Updated the API response example for snake detection to match the latest backend schema, including new fields (status_code, is_success, primaryVenomType, speciesVenoms, etc.) and more detailed snake information.
• Added a new table describing key response fields for improved developer understanding.
• Removed outdated "Next Steps" and API versioning notes to keep the documentation focused and current.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

• 🔍 Trigger a full review

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch dev

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}