chore(RND-18160): align with Vortexa Docs #554
Merged
Conversation
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
There was a problem hiding this comment.
Pull request overview
This PR aligns the SDK documentation with Vortexa's official documentation by removing references to deprecated Signals API endpoints (Vessel Summary and Vessel Positions) from the codebase. The changes include removing documentation links from source code, deleting example notebooks, and removing endpoint documentation configuration.
- Removed documentation URL references from vessel summary and vessel positions modules
- Deleted the Signals API demo notebook demonstrating deprecated endpoints
- Removed vessel summary and vessel positions documentation entries from configuration files
- Added HTML template files for documentation generation with noindex meta tags
Reviewed changes
Copilot reviewed 9 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| vortexasdk/endpoints/vessel_summary.py | Removed VortexaAPI documentation reference link from docstring |
| vortexasdk/endpoints/vessel_positions.py | Removed VortexaAPI documentation reference link from docstring |
| vortexasdk/api/vessel_summary.py | Removed VortexaAPI documentation reference link from class docstring |
| vortexasdk/api/vessel_positions.py | Removed VortexaAPI documentation reference link from class docstring |
| template.html | Added minimal HTML template with noindex/nofollow meta tag |
| pydocmd.yml | Removed vessel summary and vessel positions documentation entries from configuration |
| mkdocs.yml | Removed Signals section and vessel endpoints from documentation navigation |
| docs/examples/academy_use_cases/Signals/API Demo - Signals API.ipynb | Deleted Jupyter notebook demonstrating deprecated Signals API usage |
| custom_theme/base.html | Added custom HTML base template with noindex/nofollow meta tag for documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.