-
Notifications
You must be signed in to change notification settings - Fork 29
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
docs: standardize websocket documentation #54
Closed
devin-ai-integration
wants to merge
12
commits into
master
from
devin/1734351487-standardize-websocket-docs
Closed
docs: standardize websocket documentation #54
devin-ai-integration
wants to merge
12
commits into
master
from
devin/1734351487-standardize-websocket-docs
Conversation
This file contains 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
- Add Required Scopes section to index.md - Create documentation templates for consistency - Include frontmatter, structure, and status templates Co-Authored-By: Jacob Vad <[email protected]>
- Add Authentication section with required scope - Add Status section indicating stability - Standardize JSON example format and date - Add detailed action descriptions - Add error handling section - Add documentation tracking list Co-Authored-By: Jacob Vad <[email protected]>
- Add Authentication section with required scope - Add Status section indicating stability - Merge Usage section into Overview - Fix websockets tag to websocket - Add error handling section Co-Authored-By: Jacob Vad <[email protected]>
- Fix typo in Activities title - Add proper frontmatter with tags and keywords - Add Authentication section with required scope - Add Status section indicating stability - Add Activity Types section with descriptions - Add error handling section Co-Authored-By: Jacob Vad <[email protected]>
- Add Authentication section with required scope - Add Status section indicating stability - Fix payload heading format - Add Common Keys section with descriptions - Add error handling section Co-Authored-By: Jacob Vad <[email protected]>
- Fix incorrect title (Overlay Session Update → Channel Session Update) - Add proper frontmatter with tags and keywords - Fix incorrect description - Add Authentication section with required scope - Add Status section indicating stability - Add Session Data Types section - Add error handling section Co-Authored-By: Jacob Vad <[email protected]>
- Add proper frontmatter with tags and keywords - Fix incorrect description (pyramid → emote combo) - Add Authentication section with required scope - Add Status section indicating stability - Add Combo Detection section with patterns - Add error handling section Co-Authored-By: Jacob Vad <[email protected]>
- Add proper frontmatter with tags and keywords - Fix typo in description (sucessfully → successfully) - Add Authentication section with required scope - Add Status section indicating stability - Add Pyramid Detection section with examples - Add error handling section Co-Authored-By: Jacob Vad <[email protected]>
- Add proper frontmatter with tags and keywords - Fix topic mismatch in payload example - Add Authentication section with required scope - Update Status section to beta - Add Timeout Duration section with examples - Add error handling section Co-Authored-By: Jacob Vad <[email protected]>
…ter with tags and keywords; - Improve title and description; - Add Authentication section with required scope; - Add Status section indicating stability; - Reorganize Status Fields section; - Add error handling section Co-Authored-By: Jacob Vad <[email protected]>
Deploying docs with Cloudflare Pages
|
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
⚙️ Control Options:
Add "(aside)" to your comment to have me ignore it. |
Co-Authored-By: Jacob Vad <[email protected]>
…tion Co-Authored-By: Jacob Vad <[email protected]>
Closing due to inactivity. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
None yet
0 participants
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.
Standardize WebSocket Documentation
Standardize websocket documentation across all topics for better consistency and completeness.
Changes
Testing
Link to Devin run: https://app.devin.ai/sessions/47c7f37ee3fe4ab9bb4681fe68bc04b7