Skip to content

Commit

Permalink
feat: updating page title to the the same one in the nav bar
Browse files Browse the repository at this point in the history
  • Loading branch information
clauBv23 committed Dec 11, 2024
1 parent 02f8575 commit 1961c24
Show file tree
Hide file tree
Showing 13 changed files with 13 additions and 15 deletions.
2 changes: 1 addition & 1 deletion packages/contracts/docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
** xref:guide-develop-plugin/design-your-plugin.adoc[Designing your plugin]
** xref:guide-develop-plugin/write-plugin-contract.adoc[Writing your plugin contract]
** xref:guide-develop-plugin/write-plugin-setup-contract.adoc[Writing your plugin setup contract]
** xref:guide-develop-plugin/write-upgradeable-plugin.adoc[Writing your upgradeable plugin]
** xref:guide-develop-plugin/write-upgradeable-plugin.adoc[Writing an upgradeable plugin]
** xref:guide-develop-plugin/upgrade-plugin.adoc[Upgrading your plugin]
** xref:guide-develop-plugin/follow-best-practices.adoc[Following best practices]
** xref:guide-develop-plugin/publishing-plugin.adoc[Publishing your plugin]
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Actions & Execution
= Actions

== A Deep Dive into Actions and Execution

Expand Down
3 changes: 1 addition & 2 deletions packages/contracts/docs/modules/ROOT/pages/core/index.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
= The Contracts behind DAOs
= Core

In a nutshell, your Aragon OSx DAO consists of three pieces **DAO**, **Permission Manager**, and **Plugins**.


== The DAO contract

The DAO contract is where the **core functionality** of the protocol lies.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@

= Framework
== The Infrastructure Running the Aragon OSx Protocol

The Aragon OSx protocol is composed of **framework-related contracts** creating and managing the **core contracts**.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Before Starting
= Following best practices

== Advice for Developing a Plugin

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= How to build a DAO Plugin
= Developing a plugin

Plugins are how we extend the functionality for DAOs. In Aragon OSx, everything a DAO can do is based on Plugin functionality enabled through permissions.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Publication of your Plugin into Aragon OSx
= Publishing your plugin

Once you've deployed your Plugin Setup contract, you will be able to publish your plugin into Aragon's plugin registry so any
Aragon DAO can install it.
Expand All @@ -12,7 +12,7 @@ Publishing a plugin to Aragon OSx involves a few key steps to ensure your plugin
Make sure your Plugin Setup contract is deployed in your network of choice (you can find all of the networks we support link:https://github.com/aragon/osx-commons/tree/develop/configs/src/deployments/json[here]).
You will need the address of your Plugin Setup contract to be able to publish the plugin into the protocol.

=== Publishing your plugin
=== Publication of your Plugin into Aragon OSx

Every plugin in Aragon can have future versions, so when publishing a plugin to the Aragon protocol, we're really creating a link:https://github.com/aragon/osx/blob/develop/packages/contracts/src/framework/plugin/repo/PluginRepo.sol[PluginRepo] instance for each plugin,
which will contain all of the plugin's versions.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Plugin Contract
= Writing your plugin contract

This section will be focuses on non-upgradeable plugins development, for upgradeable plugins please check out our xref:guide-develop-plugin/write-upgradeable-plugin.adoc[guide here].

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Plugin Setup Contract
= Writing your plugin setup contract


NOTE: This section is a continuation of the xref:guide-develop-plugin/write-plugin-contract.adoc[Writing your plugin contract], and is also focused on non-upgradeable plugins, for upgradeable plugins, see xref:guide-develop-plugin/write-upgradeable-plugin.adoc[Writing your upgradeable plugin].
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Permission Conditions
= Writing custom permission conditions

Permission conditions relay the decision if an authorized call is permitted to another contract. This contract must inherit from `PermissionCondition` and implement the `IPermissionCondition` interface.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Executing actions on the DAO
= Executing actions

Executing actions on behalf of the DAO is done through the `execute` function from the `DAO.sol` contract. This function allows us to link:https://github.com/aragon/osx/blob/develop/packages/contracts/src/core/dao/DAO.sol[pass an array of actions] to be executed by the DAO contract itself.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= How to Operate a DAO
= Setting up a DAO

DAOs are decentralized autonomous organizations. They are a group of people managing on-chain assets through a set of smart contracts.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Best Practices
= Keeping your DAO safe

== Some Advice When Operating your DAO

Expand Down

0 comments on commit 1961c24

Please sign in to comment.