Skip to content

Commit

Permalink
Merge pull request #206 from aragon/staging
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
novaknole authored Dec 16, 2024
2 parents cde3efc + d88f566 commit 22d3159
Show file tree
Hide file tree
Showing 506 changed files with 15,877 additions and 43,406 deletions.
6 changes: 1 addition & 5 deletions .github/workflows/on_push.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +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
- name: Generate Subgraph Auto-Documentation
run: yarn docs:subgraph
run: yarn install --frozen-lockfile
- name: Build
run: yarn build
16 changes: 10 additions & 6 deletions .github/workflows/publish-on-fleek.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,21 @@ jobs:
node-version: 18
cache: 'yarn'

- name: Install and build
run: yarn && yarn docs:subgraph && yarn optimize-svg && yarn build
- name: Install Fleek CLI
run: npm i -g @fleek-platform/cli

- name: Activate Fleek
run: mv fleek_${{ inputs.source_branch }}.json .fleek.json
run: mv fleek_${{ inputs.source_branch }}.json fleek.config.json

- name: Install Dependencies
run: yarn install --frozen-lockfile

- name: Deploy on Fleek
id: deploy
uses: fleekhq/action-deploy@v1
with:
apiKey: ${{ secrets.FLEEK_API_KEY }}
run: fleek sites deploy
env:
FLEEK_TOKEN: ${{ secrets.FLEEK_TOKEN }}
FLEEK_PROJECT_ID: ${{ secrets.FLEEK_PROJECT_ID }}

- name: Get Fleek output URL ( Branch=${{ inputs.source_branch }} )
run: echo "The Fleek output URL is ${{ steps.deploy.outputs.deployUrl }}"
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
# Production
/build

ui/node_modules
ui/theme/dist

# Generated files
.docusaurus
.cache-loader
**/subgraph/reference-guide
/static/optimized-svg

# Misc
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` and `yarn docs:subgraph` 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, generates the Subgraph documentation, 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: ~
50 changes: 50 additions & 0 deletions components/home/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@

= Documentation

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

[.card-section]
== Guides
Aragon supports a diverse set of builders who want to build on top of OSx:

[.card-section.card-section-2col]

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

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

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


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

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.


== Governance Tooling

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

== Questions?

We’re here to help you build your DAO, plugin, or own governance-based platform.

- 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.
10 changes: 0 additions & 10 deletions docs/osx/01-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 22d3159

Please sign in to comment.