Skip to content

docs: add Operations section to README linking all runbooks#269

Open
Mrcee-arch wants to merge 1 commit into
FaveTeamz:mainfrom
Mrcee-arch:ops-runbooks
Open

docs: add Operations section to README linking all runbooks#269
Mrcee-arch wants to merge 1 commit into
FaveTeamz:mainfrom
Mrcee-arch:ops-runbooks

Conversation

@Mrcee-arch

Copy link
Copy Markdown

Cross-link all four runbooks from README.md Operations section:

  • docs/runbooks/contract-upgrade.md
  • docs/runbooks/admin-key-rotation.md
  • docs/runbooks/cap-emergency-increase.md
  • docs/runbooks/incident-response.md

Each runbook is a standalone markdown file with step-by-step commands annotated with expected output.

Summary

Changes

Testing

Checklist

  • cargo fmt applied
  • cargo clippy --features testutils -- -D warnings passes
  • cargo test --features testutils passes
  • New tests added for new behaviour
  • CHANGELOG.md updated under [Unreleased]
  • Docs updated if public API or behaviour changed
    closes docs: create runbook for common operational scenarios #211

Cross-link all four runbooks from README.md Operations section:
- docs/runbooks/contract-upgrade.md
- docs/runbooks/admin-key-rotation.md
- docs/runbooks/cap-emergency-increase.md
- docs/runbooks/incident-response.md

Each runbook is a standalone markdown file with step-by-step commands
annotated with expected output.

Closes FaveTeamz#2
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.

docs: create runbook for common operational scenarios

1 participant