Skip to content

Commit

Permalink
Merge branch 'feat/last-changes' into staging
Browse files Browse the repository at this point in the history
  • Loading branch information
clauBv23 committed Dec 11, 2024
2 parents 91ae36f + 23d22df commit 3a3e545
Show file tree
Hide file tree
Showing 6 changed files with 47 additions and 54 deletions.
68 changes: 27 additions & 41 deletions components/home/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,64 +1,50 @@
= Documentation

Aragon is a secure and modular tech stack for organizations to manage their protocols and assets onchain. Built on battle-tested infrastructure, Aragon empowers teams to create, manage, and upgrade decentralized organizations with confidence. Our comprehensive suite of tools enables everything from basic multisig management to complex, multi-stage governance systems.
= Documentation

Aragon is a secure and modular tech stack for organizations to manage their protocols and assets onchain.

== Aragon OSx

OSx is our Ethereum-based smart contract framework. It enables organizations to deploy custom governance tailored to their unique needs and securely adapt over time. It was designed to overcome the monolithic one-size-fits-approach commonly used by onchain organizations.
[.card-section]
== Guides
Aragon supports a diverse set of builders who want to build on top of OSx:

**The central principle behind OSx is that permissions are the core primitive that enables effective governance in any complex organization**.
[.card-section.card-section-2col]

== Aragon Plugin Marketplace
[.card.card-secondary.card-dao-guide]
--
xref:osx-contracts::guide-set-up-dao/index.adoc[[.card-title]#Building a DAO# [.card-body]#pass:q[Launch or upgrade your DAO directly by calling the OSx framework.]#]
--

Governance logic and other functionality is encapsulated in reusable contracts called _plugins_.
[.card.card-secondary.card-plugin-guide]
--
xref:osx-contracts::guide-develop-plugin/index.adoc[[.card-title]#Developing a plugin# [.card-body]#pass:q[Create and publish plugins to the Aragon Plugin Marketplace for others to use.]#]
--

Plugins are granted specific permissions depending what you want them to do. In practice, they often act as governing bodies or decision-making processes. For example, a token voting plugin or multisig plugin define all of their unique governance logic within the plugin itself. This “separation of concerns” keeps the protocol focused and ultimately more flexible.
[.card.card-secondary.card-building-app]
--
link:https://aragon.github.io/gov-ui-kit[[.card-title]#Building a custom application# [.card-body]#pass:q[Integrate OSx into custom web apps using our suite of React-based UI tools.]#]
--

The core plugins currently supported by Aragon are:

* *Token Voting*: Proposals are created for token holders and delegates to vote on proposals, with execution decided using a simple majority rule.
== Aragon OSx

* *Multisig*: Proposals are created for designated addresses to approve, with execution decided by whether a minimum number of approvers is met.
OSx is our Ethereum-based smart contract framework. It enables organizations to deploy custom governance tailored to their unique needs and securely adapt over time. It was designed to overcome the monolithic one-size-fits-approach commonly used by onchain organizations.

* *Admin*: Proposals are created by designated addresses and immediately executed.
**The central principle behind OSx is that permissions are the core primitive that enables effective governance in any complex organization**.

* *Staged Proposal Processor*: Proposals are created and progress through any number of stages, with other plugins either voting to approve or veto the proposal. The SPP plugin is essentially a cross-plugin state manager that enables governance processes with multiple stages and multiple governing bodies.
== Aragon Plugin Marketplace

Permissions can be granted to an OSx plugin address. Plugins contain governance logic inside of reusable contracts. Each plugin is limited in scope, with single-purpose logic that can be mixed and matched to compose novel governance designs.

**Explore or publish your own community-built plugins** that can be used to extend any OSx-based organization with new governance logic.


[.card-section]

== Governance Tooling

The Governance UI Kit and Governance App Template are used to build custom applications and UIs that integrate seamlessly with OSx.

[.card-section.card-section-2col]
====
[.card.card-primary.card-contracts]
--
xref:osx-contracts::index.adoc[[.card-title]#Osx Contracts# [.card-body]#pass:q[A smart contract framework built on Solidity, designed for creating and managing decentralized organizations.]#]
--
====

[.card.card-secondary.card-token-voting]
--
xref:token-voting::index.adoc[[.card-title]#Token Voting# [.card-body]#pass:q[A governance plugin that enables token-weighted voting.]#]
--

[.card.card-secondary.card-multisig]
--
xref:multisig::index.adoc[[.card-title]#Multisig# [.card-body]#pass:q[A governance plugin that enables a group of addresses to manage an organization through approval-based decision making.]#]
--
== Questions?

[.card.card-secondary.card-admin]
--
xref:admin::index.adoc[[.card-title]#Admin# [.card-body]#pass:q[A governance plugin that grants direct execution rights to create and execute proposals without voting or approval processes.]#]
--
We’re here to help you build your DAO, plugin, or own governance-based platform.

[.card.card-secondary.card-spp]
--
xref:spp::index.adoc[[.card-title]#Staged Proposal Processor# [.card-body]#pass:q[A governance plugin that enables multi-stage workflows, allowing to implement complex decision-making processes with multiple approval or veto checkpoints.]#]
--
- Check out our *developer community* in link:https://discord.com/invite/aragonorg[our Discord]!
- **If you’re not a developer**, head over to our link:https://www.aragon.org/resource-library[Resource Library] to learn more about how to better govern your organization with Aragon.
3 changes: 0 additions & 3 deletions playbook-master.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,6 @@ content:
- url: https://github.com/aragon/staged-proposal-processor-plugin
branches: feature/docs
start_path: docs
- url: https://github.com/aragon/gov-ui-kit
branches: feat/documentation-antora
start_path: docs
- url: https://github.com/aragon/gov-app-template
branches: feat/documentation-antora
start_path: docs
Expand Down
1 change: 1 addition & 0 deletions ui/src/css/article.scss
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,7 @@
background-color: transparent;
padding: 0;


.contract-item-name {
font-weight: var(--weight-medium);
}
Expand Down
10 changes: 5 additions & 5 deletions ui/src/css/components/cards.scss
Original file line number Diff line number Diff line change
Expand Up @@ -167,16 +167,16 @@
background-image: conic-gradient(45deg, var(--guk-color-primary-400) 0%, var(--guk-color-primary-900) 100%);
}

.card-token-voting {
--card-icon: url(../images/icons/token-voting.svg);
.card-dao-guide {
--card-icon: url(../images/icons/osx-contracts.svg);
}

.card-multisig {
.card-plugin-guide {
--card-icon: url(../images/icons/multisig.svg);
}

.card-admin {
--card-icon: url(../images/icons/admin.svg);
.card-building-app {
--card-icon: url(../images/icons/gov-ui-kit.svg);
}

.card-spp {
Expand Down
6 changes: 4 additions & 2 deletions ui/src/css/globals/_typography.scss
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ h6 {
font-family: var(--guk-font-family);
/* font-weight: var(--guk-font-weight-semibold); /* 600 */
line-height: var(--guk-line-height-tight); /* 1.25 */
margin-bottom: var(--guk-space-4); /* Consistent spacing */
margin-bottom: var(--guk-space-4);
margin-top: var(--guk-space-7);
}

/*
Expand Down Expand Up @@ -88,7 +89,8 @@ code {
border-radius: var(--guk-border-rounded); /* 4px */
font-family: var(--guk-font-family-monospace, monospace);
font-size: 0.95em;
padding: 2px 4px;
padding: 0;
border: 1px solid var(--guk-color-neutral-200);
}

/* Paragraphs and Lists */
Expand Down
13 changes: 10 additions & 3 deletions ui/theme/partials/navigation.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
{{#if (eq @root.page.component.name "ROOT")}}
<div class="nav-components">

<h3 class="nav-title">OSx</h3>
{{#each (pick site.components "osx-contracts, osx-commons-contracts")}}
<h3 class="nav-title">Aragon</h3>
{{#each (pick site.components "osx-contracts")}}
{{> navigation-component }}
{{/each}}

Expand All @@ -21,7 +21,14 @@
{{/each}}

<h3 class="nav-title">More</h3>
{{#each (pick site.components "gov-ui-kit, gov-app-template")}}
{{!-- gov-ui-kit --}}
<div class="nav-component">
<a class="flex align-center" href="https://aragon.github.io/gov-ui-kit" tabindex="0">
<img class="nav-icon" src="{{@root.site.ui.url}}/images/icons/gov-ui-kit.svg">
<span class="nav-component-heading">Governance UI Kit</span>
</a>
</div>
{{#each (pick site.components "gov-app-template")}}
{{> navigation-component }}
{{/each}}

Expand Down

0 comments on commit 3a3e545

Please sign in to comment.