From eb29ff7db6a141c4258a2f5e88f311b5dc1ecfb4 Mon Sep 17 00:00:00 2001 From: Jonas Bostoen Date: Fri, 18 Oct 2024 16:04:00 +0200 Subject: [PATCH] docs(contracts): udpate docs structure --- bolt-contracts/docs/{ => admin}/avs.json | 0 bolt-contracts/docs/{ => admin}/deploying.md | 2 +- bolt-contracts/docs/{ => admin}/upgrading.md | 2 +- 3 files changed, 2 insertions(+), 2 deletions(-) rename bolt-contracts/docs/{ => admin}/avs.json (100%) rename bolt-contracts/docs/{ => admin}/deploying.md (99%) rename bolt-contracts/docs/{ => admin}/upgrading.md (97%) diff --git a/bolt-contracts/docs/avs.json b/bolt-contracts/docs/admin/avs.json similarity index 100% rename from bolt-contracts/docs/avs.json rename to bolt-contracts/docs/admin/avs.json diff --git a/bolt-contracts/docs/deploying.md b/bolt-contracts/docs/admin/deploying.md similarity index 99% rename from bolt-contracts/docs/deploying.md rename to bolt-contracts/docs/admin/deploying.md index f92918820..8cb11783e 100644 --- a/bolt-contracts/docs/deploying.md +++ b/bolt-contracts/docs/admin/deploying.md @@ -1,4 +1,4 @@ -# Deploying +# Deployment Guide **This should only be done once with the `V1` contracts. For upgrades, refer to the [upgrading doc](./upgrading.md).** diff --git a/bolt-contracts/docs/upgrading.md b/bolt-contracts/docs/admin/upgrading.md similarity index 97% rename from bolt-contracts/docs/upgrading.md rename to bolt-contracts/docs/admin/upgrading.md index c4233d5aa..65466d91b 100644 --- a/bolt-contracts/docs/upgrading.md +++ b/bolt-contracts/docs/admin/upgrading.md @@ -1,4 +1,4 @@ -# Upgrading +# Upgrading Guide When upgrading contracts, always keep the old implementation of the contracts around and increment the version number. For example, when upgrading `BoltManagerV1`, copy it into a new file called `BoltManagerV2` and make your changes.