Skip to content

Commit

Permalink
Merge pull request #205 from aragon/feature/new-way
Browse files Browse the repository at this point in the history
Feature/new way
  • Loading branch information
novaknole authored Dec 11, 2024
2 parents d2239c1 + 5b8ab78 commit 98c31ba
Show file tree
Hide file tree
Showing 430 changed files with 15,279 additions and 27,736 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/on_push.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ jobs:
node-version: 18
registry-url: 'https://registry.npmjs.org'
- name: Install deps
run: yarn
- name: Optimize SVG images
run: yarn optimize-svg
run: yarn install --frozen-lockfile
- name: Build
run: yarn build
2 changes: 1 addition & 1 deletion .github/workflows/publish-on-fleek.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
cache: 'yarn'

- name: Install and build
run: yarn && yarn optimize-svg && yarn build
run: yarn install --frozen-lockfile && yarn build

- name: Activate Fleek
run: mv fleek_${{ inputs.source_branch }}.json .fleek.json
Expand Down
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@
# Production
/build

ui/node_modules
ui/theme/dist

# Generated files
.docusaurus
.cache-loader
/static/optimized-svg

Expand Down
1 change: 1 addition & 0 deletions .node-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
20
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"liveServer.settings.multiRootWorkspaceName": "developer-portal"
}
16 changes: 3 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@

<br/>

# Aragon OSx Developer Portal
# Aragon OSx Developer Portal.

Aragon's Developer Portal holds all documentation developers need to kickstart their journey building with the Aragon OSx stack. You can find it in production [here](https://devs.aragon.org).

This website is built using [Docusaurus 3](https://docusaurus.io/), a static website generator for technical documentations.
This website is built using [Antora](https://antora.org/), a static multi-repo website generator for technical documentations.

### Installation

Expand All @@ -38,17 +38,7 @@ This command starts a local development server and opens up a browser window. Mo
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

Notice: you may need to run `yarn optimize-svg` before `yarn build` or `yarn start` to correctly build this website.

### Serve All Optimized Assets

```bash
$ yarn serve:all-optimized
```

This command runs all the necessary commands to serve the website from scratch. It installs all the needed libraries, and then builds and serves the website, locally, with all optimized assets.
This command generates static content into the `build/site` directory and can be served using any static contents hosting service.

### Deployment

Expand Down
3 changes: 3 additions & 0 deletions components/home/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
name: ROOT
title: Home
version: ~
64 changes: 64 additions & 0 deletions components/home/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
= 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.


== 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.

**The central principle behind OSx is that permissions are the core primitive that enables effective governance in any complex organization**.

== Aragon Plugin Marketplace

Governance logic and other functionality is encapsulated in reusable contracts called _plugins_.

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.

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.

* *Multisig*: Proposals are created for designated addresses to approve, with execution decided by whether a minimum number of approvers is met.

* *Admin*: Proposals are created by designated addresses and immediately executed.

* *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.


**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.]#]
--

[.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.]#]
--

[.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.]#]
--
9 changes: 0 additions & 9 deletions docs/governanceAppTemplate/index.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/governanceUiKit/index.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/osx/00-get-started.mdx

This file was deleted.

138 changes: 0 additions & 138 deletions docs/osx/01-how-it-works/01-core/01-dao/01-actions.md

This file was deleted.

62 changes: 0 additions & 62 deletions docs/osx/01-how-it-works/01-core/01-dao/index.md

This file was deleted.

Loading

0 comments on commit 98c31ba

Please sign in to comment.