Skip to content

docs: update jsdoc documentation (for v1.34.6)#201700

Closed
maxkoryukov wants to merge 2 commits intowwebjs:mainfrom
volebo:feat/docs-update.mk
Closed

docs: update jsdoc documentation (for v1.34.6)#201700
maxkoryukov wants to merge 2 commits intowwebjs:mainfrom
volebo:feat/docs-update.mk

Conversation

@maxkoryukov
Copy link
Copy Markdown

Description

it only updates the documentation in ./docs, this PR was 99.99% generated by jsdoc

this PR also includes all changes from #201695 (Client.sendReaction), but this PR has so many changes that i decided to push it in another PR (i think this way it is easier to review the changes)

Testing Summary

I superficially reviewed the generated docs in a webbrowser, and also - i removed the files, that weren't modified from the PR (only "generated at "-like changes)

Environment

JSDoc was called for the code in git-branch feat/client-send-reaction.mk (also pushed as this PR: #201695)

  • Library Version:

whatsapp-web.js@1.34.6

  • WhatsApp Web Version:

webVersion: 2.3000.1036705643

  • Node Version:

Node 24

Type of Change

  • Dependency change (package changes such as removals, upgrades, or additions)
  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Non-code change (documentation, README, etc.)

Checklist

  • My code follows the style guidelines of this project.
  • All new and existing tests pass (npm test).
  • Typings (e.g. index.d.ts) have been updated if necessary.
  • Usage examples (e.g. example.js) / documentation have been updated if applicable.

@github-actions github-actions bot added docs Documentation changes api changes API modifications typings Type definitions labels Apr 6, 2026
@2hoch1
Copy link
Copy Markdown
Member

2hoch1 commented Apr 6, 2026

Docs are generated on release and do not require a manual change.

@maxkoryukov maxkoryukov closed this Apr 7, 2026
@maxkoryukov
Copy link
Copy Markdown
Author

Docs are generated on release and do not require a manual change.

i though since they are in the GIT - somebody wants them to be reviewed)

@2hoch1
Copy link
Copy Markdown
Member

2hoch1 commented Apr 7, 2026

Docs are generated on release and do not require a manual change.

i though since they are in the GIT - somebody wants them to be reviewed)

No worries. If you would like to contribute to the documentation or the guide, check out the wwebjs repository.

@maxkoryukov
Copy link
Copy Markdown
Author

thanks @2hoch1 !

yes, i pushed a tiny fix for the "guides" part of the documentation :

wwebjs/wwebjs.dev#117

@2hoch1
Copy link
Copy Markdown
Member

2hoch1 commented Apr 7, 2026

thanks @2hoch1 !

yes, i pushed a tiny fix for the "guides" part of the documentation :

wwebjs/wwebjs.dev#117

This repository will be archived soon. We have switched to a monorepo structure for all upcoming packages under wwebjs as well as the website itself: https://github.com/wwebjs/wwebjs/tree/main/apps/website/content/guide

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

Labels

api changes API modifications docs Documentation changes typings Type definitions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants