Skip to content

Commit

Permalink
Fix: typos and formatting issues on documentation (#434)
Browse files Browse the repository at this point in the history
  • Loading branch information
cgero-eth authored Aug 7, 2023
1 parent 9a09328 commit 1688a67
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,13 @@ Lern more about the different [plugin types](../../../02-how-to-guides/02-plugin

This raises questions on how the DAO manages plugins and who actually owns plugins.

### How does the DAO Manage a Plugin?
### How Does the DAO Manage a Plugin?

A DAO manages plugins and interactions between them. In more detail, its permission manager:

- enables the plugin installation process through the granting and revoking of permissions for the DAO
- authorizes calls to plugin functions carrying the `auth` modifier
- authorizes calls to DAO functions, for example, the `execute` function allowing for acting as the DAO

by checking if the caller `hasPermission`.
- authorizes calls to DAO functions, for example the `execute` function, allowing to act as the DAO

<div class="center-column">

Expand Down
2 changes: 0 additions & 2 deletions packages/contracts/docs/osx/01-how-it-works/01-core/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,6 @@ In a nutshell, your Aragon OSx DAO consists of three pieces:

The underlying smart contracts constitute **the core contracts** of the Aragon OSx DAO framework.

The following graphic shows how an exemplary DAO setup, where the

<div class="center-column">

![Schematic depiction of the interaction between the DAO, the PermissionManager, and a Plugin contract.](dao-plugin.drawio.svg)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ function createVersion(

The function receives four input arguments:

a) The `_release` number to create the build for. If the release number exists already (e.g., release `1`), it is registered as the latest build (e.g., `1.3` if the previous build was `1.2`). If it is a new release number, the build number is `1` (e.g., `2.1`).
b) The address of `PluginSetup` contract internally referencing the implementation contract (to copy, proxy, or clone from it) and taking care of [installing, updating to, and uninstalling](../02-plugin-setup/index.md) this specific version.
c) The `_buildMetadata` URI pointing to a JSON file containing the UI data, setup data, and change description for this specific version.
d) The `_releaseMetadata` URI pointing to a JSON file containing the plugin name, description, as well as optional data such as images to be shown in the aragonApp frontend.
1. The `_release` number to create the build for. If the release number exists already (e.g., release `1`), it is registered as the latest build (e.g., `1.3` if the previous build was `1.2`). If it is a new release number, the build number is `1` (e.g., `2.1`).
2. The address of `PluginSetup` contract internally referencing the implementation contract (to copy, proxy, or clone from it) and taking care of [installing, updating to, and uninstalling](../02-plugin-setup/index.md) this specific version.
3. The `_buildMetadata` URI pointing to a JSON file containing the UI data, setup data, and change description for this specific version.
4. The `_releaseMetadata` URI pointing to a JSON file containing the plugin name, description, as well as optional data such as images to be shown in the aragonApp frontend.

Other functions present in the contract allow you to query previous versions and to update the release metadata. For more details visit the [`PluginRepo` reference guide entry](../../../../03-reference-guide/framework/plugin/repo/PluginRepo.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ In the following, we learn what a plugin consists of.

### What Does a Plugin Consist Of?

An Aragon OSx Plugin consist of:
An Aragon OSx Plugin consists of:

- The `PluginSetup` contract

- referencing the `Plugin` implementation internally and
- referencing the `Plugin` implementation internally
- containing the setup instruction to install, update, and uninstall it to an existing DAO

- A metadata URI pointing to a `JSON` file containing the

- AragonApp frontend information
- Information needed for the setup ABI
- AragonApp frontend information
- Information needed for the setup ABI

- A version tag consisting of a

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ If you do that, nobody would be able to create proposals and execute actions on

A very important thing to consider when operating your DAO is to make sure that you do not lock it - meaning, you allow it into a state where the DAO cannot execute actions anymore.

The accidental loss of the permission to execute actions on your DAO, [the `EXECUTION_PERMISSION_ID`] permission](../../../01-how-it-works/01-core/02-permissions/index.md#permissions-native-to-the-dao-contract) this incapacitates your DAO. If this happens, you are not able to withdraw funds or act through the DAO, unless you have the `ROOT_PERMISSION_ID` on the DAO.
The accidental loss of the permission to execute actions on your DAO ([the `EXECUTION_PERMISSION_ID` permission](../../../01-how-it-works/01-core/02-permissions/index.md#permissions-native-to-the-dao-contract)) incapacitates your DAO. If this happens, you are not able to withdraw funds or act through the DAO, unless you have the `ROOT_PERMISSION_ID` on the DAO.

:::danger
Do not interact directly with the smart contracts unless you know exactly what you are doing, **especially if this involves granting or revoking permissions**. Instead, use the Aragon App or Aragon SDK for creating and managing your DAO and interacting with the smart contracts.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ If you want to review how to publish your plugin in more depth, review our [How

### Next Steps

Congratulations 🎉! You HAve developed a plugin that every Aragon DAO will be able to use.
Congratulations 🎉! You have developed a plugin that every Aragon DAO will be able to use.

Currently, it is not doing much. Let's change this by adding additional functionality. You check out our [existing plugins](https://github.com/aragon/osx/tree/develop/packages/contracts/src/plugins) as inspiration.

Expand Down

0 comments on commit 1688a67

Please sign in to comment.