Skip to content

Improve contract operational documentation and emergency recovery playbooks #541

Description

@grantfox-oss

Consolidate operational knowledge for deployment, recovery, and incident handling so developers can respond safely to upgrade, fee, or governance issues without tribal knowledge.

  • Affected files: app/contract/README.md, app/contract/CONTRIBUTING.md, app/contract/FEE_CONFIGURATION_GUIDE.md, app/contract/UPGRADE_SAFETY_GATE_QUICK_REFERENCE.md, app/contract/UPGRADE_SAFETY_GATE_TEST_GUIDE.md, app/contract/UPGRADE_SAFETY_GATE_IMPLEMENTATION.md, app/contract/documentation/, app/contract/contracts/Folder/src/metadata.rs
  • Acceptance criteria:
    • Deployment and rollback guidance cover the real upgrade and fee-routing paths used by the contract.
    • Recovery procedures explain how to diagnose and mitigate invalid fee, admin, or event-state conditions.
    • Documentation is aligned with actual contract behavior and examples from the test suite.

Activity

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

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardThird CampaignCampaign: Third CampaigndocumentationImprovements or additions to documentationhelp wantedExtra attention is needed

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions