Skip to content
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

Conversation

devin-ai-integration[bot]
Copy link

Standardize WebSocket Documentation

Standardize websocket documentation across all topics for better consistency and completeness.

Changes

  • Add consistent frontmatter with proper tags and keywords
  • Standardize documentation structure across all WebSocket topics
  • Add missing authentication sections with required scopes
  • Add status sections indicating stability level
  • Standardize JSON payload examples
  • Add error handling sections
  • Improve descriptions and explanations
  • Rename channel-overlay-update.md to channel-kvstore-update.md for clarity

Testing

  • Built documentation successfully
  • Verified all links are working
  • Checked documentation structure consistency
  • Validated JSON examples

Link to Devin run: https://app.devin.ai/sessions/47c7f37ee3fe4ab9bb4681fe68bc04b7

devin-ai-integration bot and others added 10 commits December 16, 2024 12:19
- 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]>
Copy link

cloudflare-workers-and-pages bot commented Dec 16, 2024

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2d9e272
Status: ✅  Deploy successful!
Preview URL: https://495dd520.docs-3rc.pages.dev
Branch Preview URL: https://devin-1734351487-standardize.docs-3rc.pages.dev

View logs

Copy link
Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR
  • Look at CI failures and help fix them

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Add "(aside)" to your comment to have me ignore it.

Copy link
Author

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants