Skip to content

Commit

Permalink
docs pushed
Browse files Browse the repository at this point in the history
  • Loading branch information
novaknole committed Dec 11, 2024
1 parent 0aaaf63 commit 730cf40
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Aragon OSx protocol is composed of **framework-related contracts** creating

An overview of the framework and core contracts of the Aragon OSx protocol and their interactions is shown below:

image::../../../../_/images/optimized-svg/framework/aragon-os-infrastructure-core-overview.drawio.svg[ align="center"]
image::aragon-os-infrastructure-core-overview.drawio.svg[align="center"]

In the following sections, you will learn more about the framework-related contracts of the Aragon OSx protocol.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ An Aragon OSx Plugin consists of:
A detailed explanation of the xref:guide-develop-plugin/publishing-plugin.adoc#how_to_add_a_new_version_of_your_plugin[build and release versioning] is found in the Guides sections in our developer portal.

.A schematic depiction of a plugin bundle consisting of a version tag, the plugin setup contract pointing to the plugin implementation contract, and a metadata URI.
image::../../../../_/images/optimized-svg/plugins/plugin-version.drawio.svg[align="center"]
image::plugin-version.drawio.svg[align="center"]


The `PluginSetup` is written by you, the plugin developer. The processing of the setup is managed by the `PluginSetupProcessor`, the central component of the setup process in the Aragon OSx framework, which is explained in the section xref:framework/plugin-setup-processor.adoc[The Plugin Setup Process].
Expand All @@ -46,7 +46,7 @@ Different versions might contain:


.Schematic depiction of the versioning taking place in the PluginRepoRegistry.
image::../../../../_/images/optimized-svg/plugins/plugin-repo-overview.drawio.svg[align="center"]
image::plugin-repo-overview.drawio.svg[align="center"]

Overview of the plugin versioning and registry in the Aragon OSx protocol. The `PluginRepoRegistry` contract, which is a curated list of ENS named `PluginRepo` contracts, is shown on the left. Each `PluginRepo` contract maintains a list of versions of the `PluginSetup` contract (internally referencing the `Plugin` implementation contract) and the associated UI building blocks as a URI, exemplarily shown on the right.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A DAO can be set up and customized by the *installation* , *update*, and *uninst
- **Plugin contract:** contains the plugin's implementation logic; everything needed to extend the functionality for DAOs.
- **Plugin Setup contract:** contains the instructions needed to install, update, and uninstall the plugin into the DAO. This is done through granting or revoking permissions, enabling plugins to perform actions within the scope of the DAO.
image::../../../../_/images/img/plugins/what_is_a_plugin.png[Aragon OSx Plugins]
image::what_is_a_plugin.png[Aragon OSx Plugins]

How this works:

Expand Down Expand Up @@ -83,10 +83,10 @@ TIP: The two-step setup procedure in Aragon OSx is not limited to the setup of o
In the next sections, you will learn about how plugins are curated on Aragon's repository.

.a
image::../../../../_/images/optimized-svg/plugins/plugin-installation.drawio.svg[Schematic depiction of the plugin installation process.]
image::plugin-installation.drawio.svg[Schematic depiction of the plugin installation process.]
.b
image::../../../../_/images/optimized-svg/plugins/plugin-update.drawio.svg[Schematic depiction of the plugin update process.]
image::plugin-update.drawio.svg[Schematic depiction of the plugin update process.]
.c
image::../../../../_/images/optimized-svg/plugins/plugin-uninstallation.drawio.svg[Schematic depiction of the plugin uninstallation process.]
image::plugin-uninstallation.drawio.svg[Schematic depiction of the plugin uninstallation process.]

Simplified overview of the two-transaction plugin *a.* installation, *b.* update, and *c.* uninstallation process with the involved contracts as rounded rectangles, interactions between them as arrows, and relations as dashed lines. The first and second transaction are distinguished by numbering as well as solid and dotted lines, respectively.

0 comments on commit 730cf40

Please sign in to comment.