From 4e2c8a3553a88b102e4f5e17bf3d65822ef76990 Mon Sep 17 00:00:00 2001 From: Michael Heuer Date: Wed, 22 Nov 2023 12:06:48 +0100 Subject: [PATCH 1/3] docs: fix broken dev portal build --- .../04-framework-lifecycle/01-systems.md | 12 +++--------- .../03-osx-components/01-factory-contract.md | 2 +- 2 files changed, 4 insertions(+), 10 deletions(-) diff --git a/packages/contracts/docs/developer-portal/04-framework-lifecycle/01-systems.md b/packages/contracts/docs/developer-portal/04-framework-lifecycle/01-systems.md index b90e7ea7a..c2ff9ed42 100644 --- a/packages/contracts/docs/developer-portal/04-framework-lifecycle/01-systems.md +++ b/packages/contracts/docs/developer-portal/04-framework-lifecycle/01-systems.md @@ -37,7 +37,7 @@ with construction / initialization constituting a special. -
Interfaces +#### Interfaces - `IDAO` - `IPlugin` @@ -47,9 +47,7 @@ with construction / initialization constituting a special. - `IProposal` - `IMembership` -
- -
Abstract Contracts +#### Abstract Contracts - Non-Upgradable @@ -67,9 +65,7 @@ with construction / initialization constituting a special. - `ProposalUpgradeable` - `InterfaceBasedRegistry` -
- -
Deployed Contracts +#### Deployed Contracts - Non-Upgradable @@ -86,8 +82,6 @@ with construction / initialization constituting a special. - `PluginUUPSUpgradeable` - `ENSSubdomainRegistrar` -
- ## Subgraph The subgraph is composed of diff --git a/packages/contracts/docs/developer-portal/04-framework-lifecycle/03-osx-components/01-factory-contract.md b/packages/contracts/docs/developer-portal/04-framework-lifecycle/03-osx-components/01-factory-contract.md index 4ad8f92d0..eb2df740d 100644 --- a/packages/contracts/docs/developer-portal/04-framework-lifecycle/03-osx-components/01-factory-contract.md +++ b/packages/contracts/docs/developer-portal/04-framework-lifecycle/03-osx-components/01-factory-contract.md @@ -67,4 +67,4 @@ Applies to - `DAOFactory` - `PluginRepoFactory` -For changes in the underlying implementations (i.e., `DAO` and `PluginRepo`), see the process of [replacing upgradeable contracts](../03-sub-processes/upgradeable-contract.md). +For changes in the underlying implementations (i.e., `DAO` and `PluginRepo`), see the process of [replacing upgradeable contracts](./02-upgradeable-contract.md). From 6e41ddc58ffe0eed8e092a0e009ec377cb5615f7 Mon Sep 17 00:00:00 2001 From: Michael Heuer Date: Wed, 22 Nov 2023 18:39:30 +0100 Subject: [PATCH 2/3] docs: fix broken dev portal link --- .../docs/developer-portal/04-framework-lifecycle/02-semver.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/contracts/docs/developer-portal/04-framework-lifecycle/02-semver.md b/packages/contracts/docs/developer-portal/04-framework-lifecycle/02-semver.md index daf25618e..7f549bca7 100644 --- a/packages/contracts/docs/developer-portal/04-framework-lifecycle/02-semver.md +++ b/packages/contracts/docs/developer-portal/04-framework-lifecycle/02-semver.md @@ -12,7 +12,7 @@ We use the semver notation to version the OSx Protocol smart contract and to cla ## Change Classifications -We now classify [smart contract changes](systems.md#smart-contracts) according to SemVer and how they affect the [the subgraph](01-systems.md#the-subgraph), consumers of the contracts and the subgraph such as the [the SDK or 3rd party projects](systems.md#sdk-3rd-party-projects-contract--subgraph-consumers), and [the App](01-systems.md#app). +We now classify [smart contract changes](01-systems.md#smart-contracts) according to SemVer and how they affect the [the subgraph](01-systems.md#the-subgraph), consumers of the contracts and the subgraph such as the [the SDK or 3rd party projects](01-systems.md#sdk-3rd-party-projects-contract--subgraph-consumers), and [the App](01-systems.md#app). | SemVer Classification | Change in | Affected contracts | Action | Contract Implication (OSx or 3rd party) | Subgraph | SDK | App | | --------------------- | -------------------------------------------- | --------------------- | ------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | From 01c02f4b3e28c294c0aed7cde2ab906fd96ad6ae Mon Sep 17 00:00:00 2001 From: Michael Heuer Date: Wed, 22 Nov 2023 18:46:01 +0100 Subject: [PATCH 3/3] ci: exclude framework lifecycle docs from developer portal --- .github/workflows/documentation-update.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/documentation-update.yml b/.github/workflows/documentation-update.yml index 588ca5ec2..4e57eb4dc 100644 --- a/.github/workflows/documentation-update.yml +++ b/.github/workflows/documentation-update.yml @@ -25,6 +25,9 @@ jobs: - name: Generate Docs run: yarn run docgen working-directory: packages/contracts/ + - name: Remove Framework Lifecycle docs + run: rm -rf 04-framework-lifecycle + working-directory: packages/contracts/docs/developer-portal/ - name: Format with prettier run: yarn run prettier 'packages/contracts/docs/developer-portal/03-reference-guide/**/*.md' --write - name: Checkout developer-portal