Skip to content

Updated README#198

Merged
rbnswartz merged 1 commit into
developfrom
rs/update-readme
May 19, 2026
Merged

Updated README#198
rbnswartz merged 1 commit into
developfrom
rs/update-readme

Conversation

@rbnswartz
Copy link
Copy Markdown
Member

@rbnswartz rbnswartz commented May 18, 2026

This pull request updates the README.md to document the new outgoing webhook dispatch feature and related infrastructure changes, as well as a new utility for generating verse count files. The documentation now includes details on how external systems can register for webhooks, the storage requirements for webhook registrations, and usage instructions for the new verse counting utility.

Key documentation updates:

Outgoing Webhook Dispatch:

  • Added a new section describing how external systems can register webhook endpoints to receive notifications for WACSEvent and RepoAnalysisResult messages, including the API endpoints (RegisterWebhook, UnregisterWebhook), storage in Azure Table Storage, and the dispatching mechanism via WebhookDispatcher with retry logic. [1] [2] [3] [4]
  • Updated the message topics table to show that WebhookDispatcher is now a consumer of WACSEvent and RepoAnalysisResult topics.
  • Enhanced the architecture diagram to illustrate webhook registration, storage, and event dispatch flows.

New Utility:

  • Added documentation for the CreateVerseCountsFromRepo utility, including its purpose, usage instructions, and how it supports reference verse count data generation.

Configuration:

  • Updated configuration requirements to include WebhookStorageConnectionString for both the main service and the worker, reflecting the new dependency on Azure Table Storage for webhook registrations. [1] [2]

@rbnswartz rbnswartz requested a review from PurpleGuitar May 18, 2026 19:38
@rbnswartz rbnswartz merged commit e122628 into develop May 19, 2026
4 checks passed
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.

2 participants