Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix broken link + bump docusaurus v #414

Merged
merged 1 commit into from
Oct 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion website/docs/intro/design/adapters/Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ Adapters that allow new individuals to join the DAO by providing some sort of tr

Adapters that allow different types governance systems within the DAO. Examples:

- **[Batch Voting](/docs/contracts/adapters/voting/batch-voting-adapter)**: adds the simple batching on chain voting governance process to the DAO.
- **[Basic Voting](/docs/contracts/adapters/voting/basic-voting-adapter)**: adds the no quorum, simple majority on chain voting governance process to the DAO.
- **[Offchain Voting](/docs/contracts/adapters/voting/offchain-voting-adapter)**: adds the offchain voting governance process to the DAO to support gasless voting.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/tutorial/adapters/HowToCreateAnAdapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Writes/reads to/from the DAO state based on a proposal, and the proposal needs t
// Add any `required` checks here before starting the proposal submission process.
required(pre - condition, "error message");

// Starts the submissiosn
// Starts the submission
_submitXProposal(dao, proposalId, param1, param2, paramN);
}

Expand All @@ -99,7 +99,7 @@ Writes/reads to/from the DAO state based on a proposal, and the proposal needs t
// The DAO already checks if the proposal id is not a duplicate.
dao.submitProposal(proposalId);

// Perfom any additional checks or logic you may need.
// Performing any additional checks or logic you may need.

// If you want to sponsor the proposal right away, you need to start the voting process.
IVoting votingContract = IVoting(dao.getAdapterAddress(VOTING));
Expand Down Expand Up @@ -292,7 +292,7 @@ describe("Adapter - AdapterName", () => {
});

/**
* Before each test funtion we take a chain snapshot, which
* Before each test function we take a chain snapshot, which
* contains the fresh DAO configurations with zero
* modifications.
*/
Expand Down
14 changes: 7 additions & 7 deletions website/docs/tutorial/extensions/HowToCreateAnExtension.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The key difference between an **[Adapter](/docs/tutorial/adapters/creating-an-ad
Each extension needs to be configured with the DaoRegistry **[Access Flags](/docs/contracts/core/dao-registry#access-flags)** in order to access the **[Core Contracts](/docs/intro/design/core/introduction)**, but it also can define its own Access Flags that will be required if an Adapter interacts with it.

:::tip
Extensions can defined their own Access Flags to retrict access to its functions. Any Adapter that needs to interact with the extension needs to configure the custom access flags.
Extensions can defined their own Access Flags to restrict access to its functions. Any Adapter that needs to interact with the extension needs to configure the custom access flags.
:::

### Defining the Interface
Expand All @@ -36,7 +36,7 @@ contract MyExtension is DaoConstants, IExtension {
// }

/**
* @notice Initialises the extension to be associated with a DAO
* @notice Initializes the extension to be associated with a DAO
* @dev Can only be called once
* @param creator The DAO's creator, who will be an initial member
*/
Expand Down Expand Up @@ -161,7 +161,7 @@ The extension usually saves additional state that we don't want to propagate to
- onlyAdapter
- hasExtensionAccess

After implemeting the functions that your extension will expose, and setting the correct guards, names, and conventions you should have, at this state, an extension code similar to the following example:
After creating the functions that your extension will expose, and setting the correct guards, names, and conventions you should have, at this state, an extension code similar to the following example:

```solidity
contract MyExtension is DaoConstants, IExtension {
Expand Down Expand Up @@ -309,7 +309,7 @@ describe("Extension - ExtensionName", () => {
});

/**
* Before each test funtion we take a chain snapshot, which
* Before each test function we take a chain snapshot, which
* contains the fresh DAO configurations with zero
* modifications.
*/
Expand All @@ -332,7 +332,7 @@ describe("Extension - ExtensionName", () => {
* Add a descriptive name to your test function that
* covers the use case that you are testing.
*/
it("shoud be possible to ...", async () => {
it("should be possible to ...", async () => {
// Access the global scope to read the contracts you may need.
const dao = this.dao;
const configuration = this.adapters.configuration;
Expand All @@ -356,7 +356,7 @@ describe("Extension - ExtensionName", () => {
});
```

Considering the extension that you are creating is not part of the default set of extensions, you need to declare import it, and the Factory from **[utils/OZTestUtil.js](https://github.com/openlawteam/tribute-contracts/blob/master/utils/OZTestUtil.js)**, then deploy both to be able to configure the extension access flags after it is used in the test suite, but it needs to happen _before_ the DAO is finalized. When the DAO is finalized it means that the DAO initialization has been completed, so any state changes must be done though a proposal, instead of doing it through the deployment phase. Here is a simple example of an extension configurated after its creation, but before the DAO creation is finalized:
Considering the extension that you are creating is not part of the default set of extensions, you need to declare import it, and the Factory from **[utils/OZTestUtil.js](https://github.com/openlawteam/tribute-contracts/blob/master/utils/OZTestUtil.js)**, then deploy both to be able to configure the extension access flags after it is used in the test suite, but it needs to happen _before_ the DAO is finalized. When the DAO is finalized it means that the DAO initialization has been completed, so any state changes must be done though a proposal, instead of doing it through the deployment phase. Here is a simple example of an extension configured after its creation, but before the DAO creation is finalized:

```javascript

Expand Down Expand Up @@ -421,7 +421,7 @@ describe("Extension - ExtensionName", () => {
[
entryAccessFlag(mySampleAdapter.address, {
EXECUTE: true, // the name of the ACL flag, that needs to be enabled.
// The flags deleclared here must match the flags declared in your new extension.
// The flags declared here must match the flags declared in your new extension.
}),
],
{ from: owner }
Expand Down
6 changes: 3 additions & 3 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
"gen:subgraph-doc": "docusaurus graphql-to-doc start"
},
"dependencies": {
"@docusaurus/core": "2.0.0-beta.0",
"@docusaurus/preset-classic": "2.0.0-beta.0",
"@docusaurus/theme-search-algolia": "^2.0.0-beta.0",
"@docusaurus/core": "2.0.0-beta.6",
"@docusaurus/preset-classic": "2.0.0-beta.6",
"@docusaurus/theme-search-algolia": "2.0.0-beta.6",
"@edno/docusaurus2-graphql-doc-generator": "^1.2.2",
"@mdx-js/react": "^1.6.21",
"@svgr/webpack": "^5.5.0",
Expand Down
1 change: 0 additions & 1 deletion website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ const allAdapters = {
{
Voting: [
"contracts/adapters/voting/basic-voting-adapter",
"contracts/adapters/voting/batch-voting-adapter",
"contracts/adapters/voting/offchain-voting-adapter",
],
},
Expand Down
Loading