aragon · mathewmeconry · Sep 25, 2023 · Sep 15, 2023 · Sep 15, 2023 · Sep 15, 2023
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -5,7 +5,7 @@ Please include a summary of the change and be sure you follow the contributions
 Task: [ID]()
 
 ## Type of change
-
+See the framework lifecylce in `packages/contracts/docs/framework-lifecycle` to decide what kind of change this pull request is.
 <!--- Please delete options that are not relevant. -->
 
 - [ ] Bug fix (non-breaking change which fixes an issue)
@@ -17,7 +17,6 @@ Task: [ID]()
 - [ ] I have selected the correct base branch.
 - [ ] I have performed a self-review of my own code.
 - [ ] I have commented my code, particularly in hard-to-understand areas.
-- [ ] I have made corresponding changes to the documentation.
 - [ ] My changes generate no new warnings.
 - [ ] Any dependent changes have been merged and published in downstream modules.
 - [ ] I ran all tests with success and extended them if necessary.

diff --git a/.github/workflows/documentation-update.yml b/.github/workflows/documentation-update.yml
@@ -26,7 +26,7 @@ jobs:
         run: yarn run docgen
         working-directory: packages/contracts/
       - name: Format with prettier
-        run: yarn run prettier 'packages/contracts/docs/osx/03-reference-guide/**/*.md' --write
+        run: yarn run prettier 'packages/contracts/docs/develper-portal/03-reference-guide/**/*.md' --write
       - name: Checkout developer-portal
         uses: actions/checkout@v3
         with:
@@ -36,8 +36,8 @@ jobs:
           token: ${{ secrets.ARABOT_PAT }}
       - name: Remove the docs/osx folder in the developer-portal
         run: rm -rf $GITHUB_WORKSPACE/developer-portal/docs/osx
-      - name: Copy the docs/osx folder to the developer-portal
-        run: cp -R packages/contracts/docs/osx $GITHUB_WORKSPACE/developer-portal/docs/osx
+      - name: Copy the docs/develper-portal folder to the developer-portal
+        run: cp -R packages/contracts/docs/develper-portal $GITHUB_WORKSPACE/developer-portal/docs/osx
       - name: Get short commit hash
         id: hash
         run: echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT

diff --git a/packages/contracts/.gitignore b/packages/contracts/.gitignore
@@ -5,7 +5,7 @@ node_modules
 coverage
 coverage.json
 typechain
-docs/osx/03-reference-guide
+docs/develper-portal/03-reference-guide
 
 #Hardhat files
 cache

diff --git a/...how-it-works/01-core/01-dao/01-actions.md → ...how-it-works/01-core/01-dao/01-actions.md b/...how-it-works/01-core/01-dao/01-actions.md → ...how-it-works/01-core/01-dao/01-actions.md
diff --git a/...x/01-how-it-works/01-core/01-dao/index.md → ...l/01-how-it-works/01-core/01-dao/index.md b/...x/01-how-it-works/01-core/01-dao/index.md → ...l/01-how-it-works/01-core/01-dao/index.md
diff --git a/...s/01-core/02-permissions/01-conditions.md → ...s/01-core/02-permissions/01-conditions.md b/...s/01-core/02-permissions/01-conditions.md → ...s/01-core/02-permissions/01-conditions.md
diff --git a/...-it-works/01-core/02-permissions/index.md → ...-it-works/01-core/02-permissions/index.md b/...-it-works/01-core/02-permissions/index.md → ...-it-works/01-core/02-permissions/index.md
diff --git a/...-how-it-works/01-core/03-plugins/index.md → ...-how-it-works/01-core/03-plugins/index.md b/...-how-it-works/01-core/03-plugins/index.md → ...-how-it-works/01-core/03-plugins/index.md
diff --git a/...ow-it-works/01-core/dao-plugin.drawio.svg → ...ow-it-works/01-core/dao-plugin.drawio.svg b/...ow-it-works/01-core/dao-plugin.drawio.svg → ...ow-it-works/01-core/dao-plugin.drawio.svg
diff --git a/...docs/osx/01-how-it-works/01-core/index.md → ...r-portal/01-how-it-works/01-core/index.md b/...docs/osx/01-how-it-works/01-core/index.md → ...r-portal/01-how-it-works/01-core/index.md
diff --git a/...rks/02-framework/01-dao-creation/index.md → ...rks/02-framework/01-dao-creation/index.md b/...rks/02-framework/01-dao-creation/index.md → ...rks/02-framework/01-dao-creation/index.md
diff --git a/...01-plugin-repo/01-plugin-repo-creation.md → ...01-plugin-repo/01-plugin-repo-creation.md b/...01-plugin-repo/01-plugin-repo-creation.md → ...01-plugin-repo/01-plugin-repo-creation.md
diff --git a/...plugin-management/01-plugin-repo/index.md → ...plugin-management/01-plugin-repo/index.md b/...plugin-management/01-plugin-repo/index.md → ...plugin-management/01-plugin-repo/index.md
diff --git a/...ugin-repo/plugin-repo-overview.drawio.svg → ...ugin-repo/plugin-repo-overview.drawio.svg b/...ugin-repo/plugin-repo-overview.drawio.svg → ...ugin-repo/plugin-repo-overview.drawio.svg
diff --git a/...ugin-setup/01-security-risk-mitigation.md → ...ugin-setup/01-security-risk-mitigation.md b/...ugin-setup/01-security-risk-mitigation.md → ...ugin-setup/01-security-risk-mitigation.md
diff --git a/...lugin-management/02-plugin-setup/index.md → ...lugin-management/02-plugin-setup/index.md b/...lugin-management/02-plugin-setup/index.md → ...lugin-management/02-plugin-setup/index.md
diff --git a/...ugin-setup/plugin-installation.drawio.svg → ...ugin-setup/plugin-installation.drawio.svg b/...ugin-setup/plugin-installation.drawio.svg → ...ugin-setup/plugin-installation.drawio.svg
diff --git a/...in-setup/plugin-uninstallation.drawio.svg → ...in-setup/plugin-uninstallation.drawio.svg b/...in-setup/plugin-uninstallation.drawio.svg → ...in-setup/plugin-uninstallation.drawio.svg
diff --git a/.../02-plugin-setup/plugin-update.drawio.svg → .../02-plugin-setup/plugin-update.drawio.svg b/.../02-plugin-setup/plugin-update.drawio.svg → .../02-plugin-setup/plugin-update.drawio.svg
diff --git a/...2-framework/02-plugin-management/index.md → ...2-framework/02-plugin-management/index.md b/...2-framework/02-plugin-management/index.md → ...2-framework/02-plugin-management/index.md
diff --git a/...ugin-management/plugin-version.drawio.svg → ...ugin-management/plugin-version.drawio.svg b/...ugin-management/plugin-version.drawio.svg → ...ugin-management/plugin-version.drawio.svg
diff --git a/...how-it-works/02-framework/03-ens-names.md → ...how-it-works/02-framework/03-ens-names.md b/...how-it-works/02-framework/03-ens-names.md → ...how-it-works/02-framework/03-ens-names.md
diff --git a/...s-infrastructure-core-overview.drawio.svg → ...s-infrastructure-core-overview.drawio.svg b/...s-infrastructure-core-overview.drawio.svg → ...s-infrastructure-core-overview.drawio.svg
diff --git a/...osx/01-how-it-works/02-framework/index.md → ...tal/01-how-it-works/02-framework/index.md b/...osx/01-how-it-works/02-framework/index.md → ...tal/01-how-it-works/02-framework/index.md
diff --git a/...cs/osx/01-how-it-works/03-framwork-dao.md → ...portal/01-how-it-works/03-framwork-dao.md b/...cs/osx/01-how-it-works/03-framwork-dao.md → ...portal/01-how-it-works/03-framwork-dao.md
diff --git a/...s/aragon-os-framework-overview.drawio.svg → ...s/aragon-os-framework-overview.drawio.svg b/...s/aragon-os-framework-overview.drawio.svg → ...s/aragon-os-framework-overview.drawio.svg
diff --git a/...ntracts/docs/osx/01-how-it-works/index.md → .../develper-portal/01-how-it-works/index.md b/...ntracts/docs/osx/01-how-it-works/index.md → .../develper-portal/01-how-it-works/index.md
diff --git a/...how-to-guides/01-dao/01-best-practices.md → ...how-to-guides/01-dao/01-best-practices.md b/...how-to-guides/01-dao/01-best-practices.md → ...how-to-guides/01-dao/01-best-practices.md
diff --git a/...w-to-guides/01-dao/02-action-execution.md → ...w-to-guides/01-dao/02-action-execution.md b/...w-to-guides/01-dao/02-action-execution.md → ...w-to-guides/01-dao/02-action-execution.md
diff --git a/...-to-guides/01-dao/03-protocol-upgrades.md → ...-to-guides/01-dao/03-protocol-upgrades.md b/...-to-guides/01-dao/03-protocol-upgrades.md → ...-to-guides/01-dao/03-protocol-upgrades.md
diff --git a/...uides/01-dao/04-managing-plugins/index.md → ...uides/01-dao/04-managing-plugins/index.md b/...uides/01-dao/04-managing-plugins/index.md → ...uides/01-dao/04-managing-plugins/index.md
diff --git a/...docs/osx/02-how-to-guides/01-dao/index.md → ...r-portal/02-how-to-guides/01-dao/index.md b/...docs/osx/02-how-to-guides/01-dao/index.md → ...r-portal/02-how-to-guides/01-dao/index.md
diff --git a/...2-plugin-development/01-best-practices.md → ...2-plugin-development/01-best-practices.md b/...2-plugin-development/01-best-practices.md → ...2-plugin-development/01-best-practices.md
diff --git a/.../02-plugin-development/02-plugin-types.md → .../02-plugin-development/02-plugin-types.md b/.../02-plugin-development/02-plugin-types.md → .../02-plugin-development/02-plugin-types.md
diff --git a/...n-upgradeable-plugin/01-initialization.md → ...n-upgradeable-plugin/01-initialization.md b/...n-upgradeable-plugin/01-initialization.md → ...n-upgradeable-plugin/01-initialization.md
diff --git a/...n-upgradeable-plugin/02-implementation.md → ...n-upgradeable-plugin/02-implementation.md b/...n-upgradeable-plugin/02-implementation.md → ...n-upgradeable-plugin/02-implementation.md
diff --git a/...ent/03-non-upgradeable-plugin/03-setup.md → ...ent/03-non-upgradeable-plugin/03-setup.md b/...ent/03-non-upgradeable-plugin/03-setup.md → ...ent/03-non-upgradeable-plugin/03-setup.md
diff --git a/...opment/03-non-upgradeable-plugin/index.md → ...opment/03-non-upgradeable-plugin/index.md b/...opment/03-non-upgradeable-plugin/index.md → ...opment/03-non-upgradeable-plugin/index.md
diff --git a/...4-upgradeable-plugin/01-initialization.md → ...4-upgradeable-plugin/01-initialization.md b/...4-upgradeable-plugin/01-initialization.md → ...4-upgradeable-plugin/01-initialization.md
diff --git a/...4-upgradeable-plugin/02-implementation.md → ...4-upgradeable-plugin/02-implementation.md b/...4-upgradeable-plugin/02-implementation.md → ...4-upgradeable-plugin/02-implementation.md
diff --git a/...lopment/04-upgradeable-plugin/03-setup.md → ...lopment/04-upgradeable-plugin/03-setup.md b/...lopment/04-upgradeable-plugin/03-setup.md → ...lopment/04-upgradeable-plugin/03-setup.md
diff --git a/...pgradeable-plugin/04-subsequent-builds.md → ...pgradeable-plugin/04-subsequent-builds.md b/...pgradeable-plugin/04-subsequent-builds.md → ...pgradeable-plugin/04-subsequent-builds.md
diff --git a/...pgradeable-plugin/05-updating-versions.md → ...pgradeable-plugin/05-updating-versions.md b/...pgradeable-plugin/05-updating-versions.md → ...pgradeable-plugin/05-updating-versions.md
diff --git a/...evelopment/04-upgradeable-plugin/index.md → ...evelopment/04-upgradeable-plugin/index.md b/...evelopment/04-upgradeable-plugin/index.md → ...evelopment/04-upgradeable-plugin/index.md
diff --git a/...ent/05-governance-plugins/01-proposals.md → ...ent/05-governance-plugins/01-proposals.md b/...ent/05-governance-plugins/01-proposals.md → ...ent/05-governance-plugins/01-proposals.md
diff --git a/...nt/05-governance-plugins/02-membership.md → ...nt/05-governance-plugins/02-membership.md b/...nt/05-governance-plugins/02-membership.md → ...nt/05-governance-plugins/02-membership.md
diff --git a/...evelopment/05-governance-plugins/index.md → ...evelopment/05-governance-plugins/index.md b/...evelopment/05-governance-plugins/index.md → ...evelopment/05-governance-plugins/index.md
diff --git a/...-plugin-development/06-meta-tx-plugins.md → ...-plugin-development/06-meta-tx-plugins.md b/...-plugin-development/06-meta-tx-plugins.md → ...-plugin-development/06-meta-tx-plugins.md
diff --git a/...velopment/07-publication/01-versioning.md → ...velopment/07-publication/01-versioning.md b/...velopment/07-publication/01-versioning.md → ...velopment/07-publication/01-versioning.md
diff --git a/...development/07-publication/02-metadata.md → ...development/07-publication/02-metadata.md b/...development/07-publication/02-metadata.md → ...development/07-publication/02-metadata.md
diff --git a/...lugin-development/07-publication/index.md → ...lugin-development/07-publication/index.md b/...lugin-development/07-publication/index.md → ...lugin-development/07-publication/index.md
diff --git a/...-to-guides/02-plugin-development/index.md → ...-to-guides/02-plugin-development/index.md b/...-to-guides/02-plugin-development/index.md → ...-to-guides/02-plugin-development/index.md
diff --git a/...tracts/docs/osx/02-how-to-guides/index.md → ...develper-portal/02-how-to-guides/index.md b/...tracts/docs/osx/02-how-to-guides/index.md → ...develper-portal/02-how-to-guides/index.md
diff --git a/packages/contracts/docs/develper-portal/04-framework-lifecycle/index.md b/packages/contracts/docs/develper-portal/04-framework-lifecycle/index.md
@@ -0,0 +1,7 @@
+---
+title: Framework Lifecycle
+---
+
+## Framework Lifecycle
+
+Placeholder file until the framework lifecycle docs are finished.
diff --git a/packages/contracts/docs/osx/index.md → ...s/contracts/docs/develper-portal/index.md b/packages/contracts/docs/osx/index.md → ...s/contracts/docs/develper-portal/index.md
diff --git a/packages/contracts/docs/osx/03-reference-guide/index.md b/packages/contracts/docs/osx/03-reference-guide/index.md
diff --git a/packages/contracts/hardhat.config.ts b/packages/contracts/hardhat.config.ts
@@ -129,7 +129,7 @@ const config: HardhatUserConfig = {
     deploy: './deploy',
   },
   docgen: {
-    outputDir: 'docs/osx/03-reference-guide',
+    outputDir: 'docs/develper-portal/03-reference-guide',
     theme: 'markdown',
     pages: 'files',
     templates: 'docs/templates',