Skip to content

docs(voice): add DAVE dependency section#11061

Merged
kodiakhq[bot] merged 5 commits intodiscordjs:mainfrom
jNullj:voice-readme-dave-protocol
Dec 9, 2025
Merged

docs(voice): add DAVE dependency section#11061
kodiakhq[bot] merged 5 commits intodiscordjs:mainfrom
jNullj:voice-readme-dave-protocol

Conversation

@jNullj
Copy link
Copy Markdown
Contributor

@jNullj jNullj commented Aug 22, 2025

Please describe the changes this PR makes and why it should be merged:

Support for DAVE protocol was added at #10735
Discord mention this in a past blog post here and it seems like this is about to be a requirement.
As I discovered while I got repeated crashes due to discord not downgrading my connection to a non e2ee connection!
It could be very useful if i known about this dependency while searching for a solution.
It could be also a good idea to inform users in the release notes/changelog so they know it's a good idea to add this dependency.

Made another PR for the guide as well #11145

Status and versioning classification:

  • Code changes have been tested against the Discord API, or there are no code changes
  • I know how to update typings and have done so, or typings don't need updating
  • This PR only includes non-code changes, like changes to documentation, README, etc.

@jNullj jNullj requested a review from a team as a code owner August 22, 2025 20:35
@jNullj jNullj requested a review from SpaceEEC August 22, 2025 20:35
@vercel
Copy link
Copy Markdown

vercel bot commented Aug 22, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments
Project Deployment Preview Comments Updated (UTC)
discord-js Skipped Skipped Dec 9, 2025 5:45pm
discord-js-guide Skipped Skipped Dec 9, 2025 5:45pm

@jNullj jNullj changed the title Voice readme dave protocol docs(voice): add DAVE dependency section Aug 22, 2025
@github-project-automation github-project-automation bot moved this from Todo to Review in Progress in discord.js Oct 11, 2025
@Jiralite Jiralite added this to the voice 0.20.0 milestone Oct 11, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 11, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 42.68%. Comparing base (2c3bf5c) to head (5d98e17).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main   #11061       +/-   ##
===========================================
+ Coverage   32.45%   42.68%   +10.23%     
===========================================
  Files         369      309       -60     
  Lines       13611    16566     +2955     
  Branches     1069     1657      +588     
===========================================
+ Hits         4417     7071     +2654     
- Misses       9059     9445      +386     
+ Partials      135       50       -85     
Flag Coverage Δ
voice 55.41% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>
@github-project-automation github-project-automation bot moved this from Review in Progress to Review Approved in discord.js Dec 9, 2025
@vercel vercel bot temporarily deployed to Preview – discord-js December 9, 2025 17:45 Inactive
@vercel vercel bot temporarily deployed to Preview – discord-js-guide December 9, 2025 17:45 Inactive
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Dec 9, 2025

📝 Walkthrough

Walkthrough

Added a new subsection documenting DAVE Protocol Libraries for end-to-end encryption under the Encryption Libraries section of the package README, along with a warning note about Discord client requirements and a new dependency.

Changes

Cohort / File(s) Summary
Documentation & Dependencies
packages/voice/README.md
Added "DAVE Protocol Libraries (e2ee)" subsection under Encryption Libraries with warning note about Discord client requirements; added @snazzah/davey: ^0.1.6 dependency

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding documentation about the DAVE dependency in the voice package README.
Description check ✅ Passed The description clearly explains the context and rationale for adding DAVE protocol documentation, referencing Discord's announcement and the practical need to prevent user crashes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

@kodiakhq kodiakhq bot merged commit 4db1092 into discordjs:main Dec 9, 2025
7 of 8 checks passed
@github-project-automation github-project-automation bot moved this from Review Approved to Done in discord.js Dec 9, 2025
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eaa6863 and 5d98e17.

📒 Files selected for processing (1)
  • packages/voice/README.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
packages/voice/README.md

65-65: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Tests
🔇 Additional comments (1)
packages/voice/README.md (1)

65-70: Content looks good, well-integrated into the dependencies section.

The warning note clearly explains the requirement and the dependency listing is properly formatted. The addition fits naturally into the existing Documentation section structure and complements the previous Encryption Libraries section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants