-
Notifications
You must be signed in to change notification settings - Fork 5
Docs: Enhance API Documentation with JSON:API Guide, Polling vs Webhooks, and Core Examples #129
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
base: main
Are you sure you want to change the base?
Conversation
| <Note> | ||
| See the [Tracking Request Lifecycle](/api-docs/in-depth-guides/tracking-request-lifecycle) guide for a complete list of failure reasons. | ||
| </Note> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation references a "Tracking Request Lifecycle" guide that doesn't appear to exist yet based on the Documentation Improvement Tracker. This creates a broken link for users. Consider either:
- Creating the referenced guide as part of this PR
- Updating this reference to point to existing documentation
- Adding a note that this guide is coming soon
Broken documentation links can frustrate users trying to find complete information about failure reasons.
| <Note> | |
| See the [Tracking Request Lifecycle](/api-docs/in-depth-guides/tracking-request-lifecycle) guide for a complete list of failure reasons. | |
| </Note> | |
| <Note> | |
| For information about possible failure reasons, see our [Error Handling documentation](/api-docs/guides/error-handling). | |
| </Note> |
Spotted by Diamond
Is this helpful? React 👍 or 👎 to let us know.
This PR enhances the Terminal49 API documentation with several key improvements:
New Guides
Updated Core Documentation
Documentation Structure
/docsfolder following Mintlify standardsThese changes aim to make Terminal49's API more approachable for new developers while providing in-depth resources for advanced integration scenarios.