Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Stacy seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
Summary
Errors per inputErrors in docs/guides/contract-updatability.mdx
|
🚀 Preview Deployment✅ Deployment Ready 🔗 Preview URL: https://pr-776-midnight-docs.vercel.app 📝 Latest commit: This preview updates automatically when you push new commits to this PR. |
|
Really great content complete with industry comparisons, code example and best practices for security concerns. I'm approving for accuracy of the content and assigning @gyrationtechs to review for technical writing style to match docs best practices. Thank you @Anastasiya737 |
gyrationtechs
left a comment
gyrationtechs
left a comment
There was a problem hiding this comment.
@Anastasiya737 Thank you for this. Detailed and easy to follow along.
A few minor suggestions. Then g2g!
| sidebar_position: 40 | ||
| --- | ||
|
|
||
| # Making Decision on Contract Updatability |
There was a problem hiding this comment.
The H1 title should ideally match the doc title. Let's also update it to use sentence case for the heading.
| This guide explains how contract updatability is enabled in the Midnight network and why every DApp | ||
| developer has to understand its importance for uninterruptible and long-term contract operation. | ||
|
|
||
| ## Importance of the Updatability Feature |
There was a problem hiding this comment.
Use sentence case for headings.
| evolving proof generation and verification rules. A contract may become unusable because its proofs | ||
| can no longer be generated or verified. | ||
|
|
||
| To address this, Midnight provides contract updatability via a ContractMaintenanceAuthority that can |
There was a problem hiding this comment.
Is ContractMaintenanceAuthority a single word or needs to be separated?
| Track proof system changes via [release compatibility matrix](../relnotes/support-matrix) and plan | ||
| circuit updates in advance whenever an upcoming release affects your contracts. | ||
|
|
||
| ## How Updatability Works |
There was a problem hiding this comment.
Sentence case for headings
|
|
||
| Operating a maintenance authority requires: | ||
|
|
||
| - Configuring the CMA during contract deployment (a set of the committee public keys and a signature |
There was a problem hiding this comment.
Use periods for each list item for consistency.
4 participants
contract updatability doc