[doc] Add a readme template for generate docs

README.md

@@ -1,5 +1,16 @@
 # Starcoin Move framework
 
+## Network Deploy status
+
+- halley: latest
+- proxima: v11
+- barnard: v11
+- main: v11
+
+## Documents
+
+- [latest](./build/StarcoinFramework/docs)
+- [v11](./release/v11/docs)
 
 ## Build and Test
 

build/StarcoinFramework/docs/README.md

@@ -0,0 +1,96 @@
+
+<a name="@Move_StarcoinFramework_Modules_0"></a>
+
+# Move StarcoinFramework Modules
+
+
+This is the root document for the Move StarcoinFramework module documentation. The Move StarcoinFramework provides modules that can be used to access or interact with Starcoin blockchain.
+
+
+<a name="@Index_1"></a>
+
+## Index
+
+
+-  [`0x1::Account`](Account.md#0x1_Account)
+-  [`0x1::AccountScripts`](AccountScripts.md#0x1_AccountScripts)
+-  [`0x1::Arith`](U256.md#0x1_Arith)
+-  [`0x1::Authenticator`](Authenticator.md#0x1_Authenticator)
+-  [`0x1::BCS`](BCS.md#0x1_BCS)
+-  [`0x1::BitOperators`](Bitwise.md#0x1_BitOperators)
+-  [`0x1::Block`](Block.md#0x1_Block)
+-  [`0x1::BlockReward`](BlockReward.md#0x1_BlockReward)
+-  [`0x1::ChainId`](ChainId.md#0x1_ChainId)
+-  [`0x1::Collection`](Collection.md#0x1_Collection)
+-  [`0x1::Collection2`](Collection2.md#0x1_Collection2)
+-  [`0x1::Compare`](Compare.md#0x1_Compare)
+-  [`0x1::Config`](Config.md#0x1_Config)
+-  [`0x1::ConsensusConfig`](ConsensusConfig.md#0x1_ConsensusConfig)
+-  [`0x1::ConsensusStrategy`](ConsensusStrategy.md#0x1_ConsensusStrategy)
+-  [`0x1::CoreAddresses`](CoreAddresses.md#0x1_CoreAddresses)
+-  [`0x1::Dao`](Dao.md#0x1_Dao)
+-  [`0x1::DaoVoteScripts`](DaoVoteScripts.md#0x1_DaoVoteScripts)
+-  [`0x1::Debug`](Debug.md#0x1_Debug)
+-  [`0x1::DummyToken`](DummyToken.md#0x1_DummyToken)
+-  [`0x1::DummyTokenScripts`](DummyToken.md#0x1_DummyTokenScripts)
+-  [`0x1::EVMAddress`](Signature.md#0x1_EVMAddress)
+-  [`0x1::EmptyScripts`](EmptyScripts.md#0x1_EmptyScripts)
+-  [`0x1::Epoch`](Epoch.md#0x1_Epoch)
+-  [`0x1::Errors`](Errors.md#0x1_Errors)
+-  [`0x1::Event`](Event.md#0x1_Event)
+-  [`0x1::FixedPoint32`](FixedPoint32.md#0x1_FixedPoint32)
+-  [`0x1::Genesis`](Genesis.md#0x1_Genesis)
+-  [`0x1::GenesisNFT`](GenesisNFT.md#0x1_GenesisNFT)
+-  [`0x1::GenesisNFTScripts`](GenesisNFT.md#0x1_GenesisNFTScripts)
+-  [`0x1::GenesisSignerCapability`](GenesisSignerCapability.md#0x1_GenesisSignerCapability)
+-  [`0x1::Hash`](Hash.md#0x1_Hash)
+-  [`0x1::IdentifierNFT`](NFT.md#0x1_IdentifierNFT)
+-  [`0x1::IdentifierNFTScripts`](NFT.md#0x1_IdentifierNFTScripts)
+-  [`0x1::LanguageVersion`](LanguageVersion.md#0x1_LanguageVersion)
+-  [`0x1::Math`](Math.md#0x1_Math)
+-  [`0x1::MerkleNFTDistributor`](MerkleNFT.md#0x1_MerkleNFTDistributor)
+-  [`0x1::MerkleProof`](MerkleNFT.md#0x1_MerkleProof)
+-  [`0x1::MintDaoProposal`](MintDaoProposal.md#0x1_MintDaoProposal)
+-  [`0x1::MintScripts`](MintScripts.md#0x1_MintScripts)
+-  [`0x1::ModifyDaoConfigProposal`](ModifyDaoConfigProposal.md#0x1_ModifyDaoConfigProposal)
+-  [`0x1::ModuleUpgradeScripts`](ModuleUpgradeScripts.md#0x1_ModuleUpgradeScripts)
+-  [`0x1::NFT`](NFT.md#0x1_NFT)
+-  [`0x1::NFTGallery`](NFT.md#0x1_NFTGallery)
+-  [`0x1::NFTGalleryScripts`](NFT.md#0x1_NFTGalleryScripts)
+-  [`0x1::Offer`](Offer.md#0x1_Offer)
+-  [`0x1::OnChainConfigDao`](OnChainConfigDao.md#0x1_OnChainConfigDao)
+-  [`0x1::OnChainConfigScripts`](OnChainConfigScripts.md#0x1_OnChainConfigScripts)
+-  [`0x1::Option`](Option.md#0x1_Option)
+-  [`0x1::Oracle`](Oracle.md#0x1_Oracle)
+-  [`0x1::PackageTxnManager`](PackageTxnManager.md#0x1_PackageTxnManager)
+-  [`0x1::PriceOracle`](Oracle.md#0x1_PriceOracle)
+-  [`0x1::PriceOracleAggregator`](Oracle.md#0x1_PriceOracleAggregator)
+-  [`0x1::PriceOracleScripts`](Oracle.md#0x1_PriceOracleScripts)
+-  [`0x1::RewardConfig`](RewardConfig.md#0x1_RewardConfig)
+-  [`0x1::SIP_2`](SIPs.md#0x1_SIP_2)
+-  [`0x1::SIP_3`](SIPs.md#0x1_SIP_3)
+-  [`0x1::STC`](STC.md#0x1_STC)
+-  [`0x1::STCUSDOracle`](Oracle.md#0x1_STCUSDOracle)
+-  [`0x1::SharedEd25519PublicKey`](SharedEd25519PublicKey.md#0x1_SharedEd25519PublicKey)
+-  [`0x1::Signature`](Signature.md#0x1_Signature)
+-  [`0x1::SignedInteger64`](SignedInteger64.md#0x1_SignedInteger64)
+-  [`0x1::Signer`](Signer.md#0x1_Signer)
+-  [`0x1::StdlibUpgradeScripts`](StdlibUpgradeScripts.md#0x1_StdlibUpgradeScripts)
+-  [`0x1::Timestamp`](Timestamp.md#0x1_Timestamp)
+-  [`0x1::Token`](Token.md#0x1_Token)
+-  [`0x1::TransactionFee`](TransactionFee.md#0x1_TransactionFee)
+-  [`0x1::TransactionManager`](TransactionManager.md#0x1_TransactionManager)
+-  [`0x1::TransactionPublishOption`](TransactionPublishOption.md#0x1_TransactionPublishOption)
+-  [`0x1::TransactionTimeout`](TransactionTimeout.md#0x1_TransactionTimeout)
+-  [`0x1::TransactionTimeoutConfig`](TransactionTimeoutConfig.md#0x1_TransactionTimeoutConfig)
+-  [`0x1::TransferScripts`](TransferScripts.md#0x1_TransferScripts)
+-  [`0x1::Treasury`](Treasury.md#0x1_Treasury)
+-  [`0x1::TreasuryScripts`](TreasuryScripts.md#0x1_TreasuryScripts)
+-  [`0x1::TreasuryWithdrawDaoProposal`](TreasuryWithdrawDaoProposal.md#0x1_TreasuryWithdrawDaoProposal)
+-  [`0x1::U256`](U256.md#0x1_U256)
+-  [`0x1::UpgradeModuleDaoProposal`](UpgradeModuleDaoProposal.md#0x1_UpgradeModuleDaoProposal)
+-  [`0x1::VMConfig`](VMConfig.md#0x1_VMConfig)
+-  [`0x1::Vector`](Vector.md#0x1_Vector)
+-  [`0x1::Version`](Version.md#0x1_Version)
+-  [`0x1::YieldFarming`](YieldFarming.md#0x1_YieldFarming)
+-  [`0x1::YieldFarmingV2`](YieldFarmingV2.md#0x1_YieldFarmingV2)

doc_templates/README.md

@@ -0,0 +1,7 @@
+# Move StarcoinFramework Modules
+
+This is the root document for the Move StarcoinFramework module documentation. The Move StarcoinFramework provides modules that can be used to access or interact with Starcoin blockchain.
+
+## Index
+
+> {{move-index}}

release_notes.md → release/README.md

@@ -57,16 +57,17 @@
 
 - YieldFarmingV2: fix #2989
 
-### Version 10
+## Version 10
 
 - Add `0x1::Signature::ecrecover` , `0x1::Hash::ripemd160` and `0x1::EVMAddress`. (#3020)
 - Store `VMConfig` info in Module, instead of Resource. (#3019)
 - Make `append`, `remove`, `reverse` native in Vector. (#3055)
 - Add `U256` implementation. (#3032)
 - improve account balance function.(#3058)
 
-### Version 11
+## Version 11
 
 - Upgrade bytecode to v4.(#3109)
 - Use move pacakge system to organize stdlib source files.(#3109)
-- Add `phantom` modifier to NFT and Token Module. (#3109)
+- Add `phantom` modifier to NFT and Token Module. (#3109)
+- [docs](./v11/docs)

release/v11/docs/README.md

@@ -0,0 +1,96 @@
+
+<a name="@Move_StarcoinFramework_Modules_0"></a>
+
+# Move StarcoinFramework Modules
+
+
+This is the root document for the Move StarcoinFramework module documentation. The Move StarcoinFramework provides modules that can be used to access or interact with Starcoin blockchain.
+
+
+<a name="@Index_1"></a>
+
+## Index
+
+
+-  [`0x1::Account`](Account.md#0x1_Account)
+-  [`0x1::AccountScripts`](AccountScripts.md#0x1_AccountScripts)
+-  [`0x1::Arith`](U256.md#0x1_Arith)
+-  [`0x1::Authenticator`](Authenticator.md#0x1_Authenticator)
+-  [`0x1::BCS`](BCS.md#0x1_BCS)
+-  [`0x1::BitOperators`](Bitwise.md#0x1_BitOperators)
+-  [`0x1::Block`](Block.md#0x1_Block)
+-  [`0x1::BlockReward`](BlockReward.md#0x1_BlockReward)
+-  [`0x1::ChainId`](ChainId.md#0x1_ChainId)
+-  [`0x1::Collection`](Collection.md#0x1_Collection)
+-  [`0x1::Collection2`](Collection2.md#0x1_Collection2)
+-  [`0x1::Compare`](Compare.md#0x1_Compare)
+-  [`0x1::Config`](Config.md#0x1_Config)
+-  [`0x1::ConsensusConfig`](ConsensusConfig.md#0x1_ConsensusConfig)
+-  [`0x1::ConsensusStrategy`](ConsensusStrategy.md#0x1_ConsensusStrategy)
+-  [`0x1::CoreAddresses`](CoreAddresses.md#0x1_CoreAddresses)
+-  [`0x1::Dao`](Dao.md#0x1_Dao)
+-  [`0x1::DaoVoteScripts`](DaoVoteScripts.md#0x1_DaoVoteScripts)
+-  [`0x1::Debug`](Debug.md#0x1_Debug)
+-  [`0x1::DummyToken`](DummyToken.md#0x1_DummyToken)
+-  [`0x1::DummyTokenScripts`](DummyToken.md#0x1_DummyTokenScripts)
+-  [`0x1::EVMAddress`](Signature.md#0x1_EVMAddress)
+-  [`0x1::EmptyScripts`](EmptyScripts.md#0x1_EmptyScripts)
+-  [`0x1::Epoch`](Epoch.md#0x1_Epoch)
+-  [`0x1::Errors`](Errors.md#0x1_Errors)
+-  [`0x1::Event`](Event.md#0x1_Event)
+-  [`0x1::FixedPoint32`](FixedPoint32.md#0x1_FixedPoint32)
+-  [`0x1::Genesis`](Genesis.md#0x1_Genesis)
+-  [`0x1::GenesisNFT`](GenesisNFT.md#0x1_GenesisNFT)
+-  [`0x1::GenesisNFTScripts`](GenesisNFT.md#0x1_GenesisNFTScripts)
+-  [`0x1::GenesisSignerCapability`](GenesisSignerCapability.md#0x1_GenesisSignerCapability)
+-  [`0x1::Hash`](Hash.md#0x1_Hash)
+-  [`0x1::IdentifierNFT`](NFT.md#0x1_IdentifierNFT)
+-  [`0x1::IdentifierNFTScripts`](NFT.md#0x1_IdentifierNFTScripts)
+-  [`0x1::LanguageVersion`](LanguageVersion.md#0x1_LanguageVersion)
+-  [`0x1::Math`](Math.md#0x1_Math)
+-  [`0x1::MerkleNFTDistributor`](MerkleNFT.md#0x1_MerkleNFTDistributor)
+-  [`0x1::MerkleProof`](MerkleNFT.md#0x1_MerkleProof)
+-  [`0x1::MintDaoProposal`](MintDaoProposal.md#0x1_MintDaoProposal)
+-  [`0x1::MintScripts`](MintScripts.md#0x1_MintScripts)
+-  [`0x1::ModifyDaoConfigProposal`](ModifyDaoConfigProposal.md#0x1_ModifyDaoConfigProposal)
+-  [`0x1::ModuleUpgradeScripts`](ModuleUpgradeScripts.md#0x1_ModuleUpgradeScripts)
+-  [`0x1::NFT`](NFT.md#0x1_NFT)
+-  [`0x1::NFTGallery`](NFT.md#0x1_NFTGallery)
+-  [`0x1::NFTGalleryScripts`](NFT.md#0x1_NFTGalleryScripts)
+-  [`0x1::Offer`](Offer.md#0x1_Offer)
+-  [`0x1::OnChainConfigDao`](OnChainConfigDao.md#0x1_OnChainConfigDao)
+-  [`0x1::OnChainConfigScripts`](OnChainConfigScripts.md#0x1_OnChainConfigScripts)
+-  [`0x1::Option`](Option.md#0x1_Option)
+-  [`0x1::Oracle`](Oracle.md#0x1_Oracle)
+-  [`0x1::PackageTxnManager`](PackageTxnManager.md#0x1_PackageTxnManager)
+-  [`0x1::PriceOracle`](Oracle.md#0x1_PriceOracle)
+-  [`0x1::PriceOracleAggregator`](Oracle.md#0x1_PriceOracleAggregator)
+-  [`0x1::PriceOracleScripts`](Oracle.md#0x1_PriceOracleScripts)
+-  [`0x1::RewardConfig`](RewardConfig.md#0x1_RewardConfig)
+-  [`0x1::SIP_2`](SIPs.md#0x1_SIP_2)
+-  [`0x1::SIP_3`](SIPs.md#0x1_SIP_3)
+-  [`0x1::STC`](STC.md#0x1_STC)
+-  [`0x1::STCUSDOracle`](Oracle.md#0x1_STCUSDOracle)
+-  [`0x1::SharedEd25519PublicKey`](SharedEd25519PublicKey.md#0x1_SharedEd25519PublicKey)
+-  [`0x1::Signature`](Signature.md#0x1_Signature)
+-  [`0x1::SignedInteger64`](SignedInteger64.md#0x1_SignedInteger64)
+-  [`0x1::Signer`](Signer.md#0x1_Signer)
+-  [`0x1::StdlibUpgradeScripts`](StdlibUpgradeScripts.md#0x1_StdlibUpgradeScripts)
+-  [`0x1::Timestamp`](Timestamp.md#0x1_Timestamp)
+-  [`0x1::Token`](Token.md#0x1_Token)
+-  [`0x1::TransactionFee`](TransactionFee.md#0x1_TransactionFee)
+-  [`0x1::TransactionManager`](TransactionManager.md#0x1_TransactionManager)
+-  [`0x1::TransactionPublishOption`](TransactionPublishOption.md#0x1_TransactionPublishOption)
+-  [`0x1::TransactionTimeout`](TransactionTimeout.md#0x1_TransactionTimeout)
+-  [`0x1::TransactionTimeoutConfig`](TransactionTimeoutConfig.md#0x1_TransactionTimeoutConfig)
+-  [`0x1::TransferScripts`](TransferScripts.md#0x1_TransferScripts)
+-  [`0x1::Treasury`](Treasury.md#0x1_Treasury)
+-  [`0x1::TreasuryScripts`](TreasuryScripts.md#0x1_TreasuryScripts)
+-  [`0x1::TreasuryWithdrawDaoProposal`](TreasuryWithdrawDaoProposal.md#0x1_TreasuryWithdrawDaoProposal)
+-  [`0x1::U256`](U256.md#0x1_U256)
+-  [`0x1::UpgradeModuleDaoProposal`](UpgradeModuleDaoProposal.md#0x1_UpgradeModuleDaoProposal)
+-  [`0x1::VMConfig`](VMConfig.md#0x1_VMConfig)
+-  [`0x1::Vector`](Vector.md#0x1_Vector)
+-  [`0x1::Version`](Version.md#0x1_Version)
+-  [`0x1::YieldFarming`](YieldFarming.md#0x1_YieldFarming)
+-  [`0x1::YieldFarmingV2`](YieldFarmingV2.md#0x1_YieldFarmingV2)