docs: add deployment guide, operational runbook, and chain deployments reference - #11
Merged
jean-neiverth merged 5 commits intoSep 24, 2026
Conversation
Adds operations/deployment.md with the two-step deployment order (contracts first, then service) and links to each repo's deploy guide. Updates overview.md to include the new page in the documentation map.
Adds operations/runbook.md covering the admin dashboard (four pages with usage guidance), logging (key log lines per worker), Slack notifications (event table and Redis persistence note), uptime monitoring (healthz limitation callout), and a monitoring checklist. Updates overview.md to include the runbook in the documentation map.
Extracts the BNB Chain addresses and endpoints from the sub-solver integration guide into a dedicated reference/deployments.md file. Replaces the inline table with a link. Updates overview.md to include the new page in the documentation map.
jean-neiverth
changed the title
yvesfracari
approved these changes
Sep 23, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Summary
operations/deployment.md— deployment order (contracts first, then service) with links to each repo's deploy guideoperations/runbook.md— operational runbook covering the admin dashboard (four pages with usage guidance), logging (key log lines per worker), Slack notification events, uptime monitoring caveat, and a monitoring checklistreference/deployments.md— chain-specific addresses and endpoints per active BYOS deployment (BNB Chain staging)reference/deployments.mdoverview.mdto include all new pages in the documentation mapTest plan
operations/runbook.mdand verify log line names match the service implementationreference/deployments.mdmatches the values previously in the sub-solver guide