Docs: Enhance API Documentation with JSON:API Guide, Polling vs Webhooks, and Core Examples#129
Open
Docs: Enhance API Documentation with JSON:API Guide, Polling vs Webhooks, and Core Examples#129
Conversation
Comment on lines
+216
to
+218
| <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.
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.
Suggested change
| <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 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
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.
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.