new changes

aragon · Nov 22, 2024 · 43255c2 · 43255c2
1 parent 6f96412
commit 43255c2
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 322 deletions.
diff --git a/packages/contracts/docs/ERC20/IERC20MintableUpgradeable.md b/packages/contracts/docs/ERC20/IERC20MintableUpgradeable.md
diff --git a/packages/contracts/docs/ERC20/governance/GovernanceERC20.md b/packages/contracts/docs/ERC20/governance/GovernanceERC20.md
diff --git a/packages/contracts/docs/ERC20/governance/GovernanceWrappedERC20.md b/packages/contracts/docs/ERC20/governance/GovernanceWrappedERC20.md
diff --git a/packages/contracts/docs/ERC20/governance/IGovernanceWrappedERC20.md b/packages/contracts/docs/ERC20/governance/IGovernanceWrappedERC20.md
diff --git a/packages/contracts/docs/config.js b/packages/contracts/docs/config.js
@@ -1,12 +1,12 @@
 const path = require('path');
 const fs = require('fs');
 
-const {version, repository} = require('../package.json');
+const { version, repository } = require('../package.json');
 
 const helpers = require(path.resolve(__dirname, './templates/helpers'));
 
 // overwrite the functions.
-helpers.version = () => version;
+helpers.version = () => `${version}/packages/contracts`;
 helpers.githubURI = () => repository.url;
 
 /** @type import('solidity-docgen/dist/config').UserConfig */

diff --git a/packages/contracts/docs/modules/api/pages/TokenVoting.adoc b/packages/contracts/docs/modules/api/pages/TokenVoting.adoc
@@ -112,7 +112,7 @@ This is for testing purposes.
 
 [.contract]
 [[TokenVoting]]
-=== `++TokenVoting++` link:https://github.com/aragon/token-voting-plugin/blob/v/src/TokenVoting.sol[{github-icon},role=heading-link]
+=== `++TokenVoting++` link:https://github.com/aragon/token-voting-plugin/blob/1.4.0-alpha.1/packages/contracts/src/TokenVoting.sol[{github-icon},role=heading-link]
 
 v1.3 (Release 1, Build 3). For each upgrade, if the reinitialization step is required,
      increment the version numbers in the modifier for both the initialize and initializeFrom functions.
@@ -597,7 +597,7 @@ The [ERC-165](https://eips.ethereum.org/EIPS/eip-165) interface ID of the contra
 
 [.contract]
 [[MajorityVotingBase]]
-=== `++MajorityVotingBase++` link:https://github.com/aragon/token-voting-plugin/blob/v/src/MajorityVotingBase.sol[{github-icon},role=heading-link]
+=== `++MajorityVotingBase++` link:https://github.com/aragon/token-voting-plugin/blob/1.4.0-alpha.1/packages/contracts/src/MajorityVotingBase.sol[{github-icon},role=heading-link]
 
 This contract implements the `IMajorityVoting` interface.
 
@@ -1228,7 +1228,7 @@ A mapping between proposal IDs and proposal information.
 
 [.contract]
 [[TokenVotingSetup]]
-=== `++TokenVotingSetup++` link:https://github.com/aragon/token-voting-plugin/blob/v/src/TokenVotingSetup.sol[{github-icon},role=heading-link]
+=== `++TokenVotingSetup++` link:https://github.com/aragon/token-voting-plugin/blob/1.4.0-alpha.1/packages/contracts/src/TokenVotingSetup.sol[{github-icon},role=heading-link]
 
 v1.3 (Release 1, Build 3)
 
@@ -1355,7 +1355,7 @@ Thrown if token address is not ERC20.
 
 [.contract]
 [[VotingPowerCondition]]
-=== `++VotingPowerCondition++` link:https://github.com/aragon/token-voting-plugin/blob/v/src/VotingPowerCondition.sol[{github-icon},role=heading-link]
+=== `++VotingPowerCondition++` link:https://github.com/aragon/token-voting-plugin/blob/1.4.0-alpha.1/packages/contracts/src/VotingPowerCondition.sol[{github-icon},role=heading-link]
 
 [.contract-index]
 .Functions

diff --git a/packages/contracts/hardhat.config.ts b/packages/contracts/hardhat.config.ts
@@ -179,7 +179,7 @@ const config: HardhatUserConfig = {
     outDir: 'typechain',
     target: 'ethers-v5',
   },
-  docgen: require('./docs/config.js'),
+  docgen: process.env.DOCS ? require('./docs/config.js') : undefined,
 };
 
 export default config;
diff --git a/packages/contracts/package.json b/packages/contracts/package.json
@@ -1,5 +1,6 @@
 {
   "license": "AGPL-3.0-or-later",
+  "version": "1.4.0-alpha.1",
   "scripts": {
     "build": "cross-env TS_NODE_TRANSPILE_ONLY=true hardhat compile",
     "coverage": "hardhat coverage --solcoverjs ./.solcover.js --temp artifacts --testfiles \"test/**/*.ts\" && yarn typechain",
@@ -8,8 +9,7 @@
     "lint:sol": "cd ../../ && yarn run lint:contracts:sol",
     "lint:ts": "cd ../../ && yarn run lint:contracts:ts",
     "test": "hardhat test",
-    "docgen": "hardhat docgen",
-    "docs": "scripts/prepare-docs.sh",
+    "docs": "DOCS=true scripts/prepare-docs.sh",
     "typechain": "cross-env TS_NODE_TRANSPILE_ONLY=true hardhat typechain",
     "clean": "rimraf ./artifacts ./cache ./coverage ./typechain ./types ./coverage.json && yarn typechain"
   },