Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update readme #207

Merged
merged 10 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/on_push.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ jobs:
- name: Install deps
run: yarn install --frozen-lockfile
- name: Build
run: yarn build
run: yarn build:staging
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/node_modules

# Production
/build
build

ui/node_modules
ui/theme/dist
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
<a href="https://devs.aragon.org/">Developer Portal</a>
<a href="https://aragondevelopers.substack.com/">Join our Developer Community</a>
<a href="https://aragonproject.typeform.com/dx-contribution">Contribute</a>
</p>

<br/>
Expand All @@ -32,3 +30,7 @@ $ yarn build:local
```

For this command to work, you need to create `playbook-local-only.yml`. For reference, you can use `playbook-master.yml` or `playbook-staging.yml` to fill in the information.

### Adding a new repo to the docs

Edit the [playbook-master.yml](playbook-master.yml) (or [playbook-staging.yml](playbook-staging.yml)) file by adding the new repository under "sources", with the branch or branches that should be deployed, and the path where the `antora.yml` file is. To show it in the sidebar, add the name from the repo's antora.yml in navigation.hbs, and add an svg icon inside the icons folder matching the name.
6 changes: 2 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,8 @@
"build:local": "bash scripts/build.sh playbook-local-only.yml",
"build:no-fetch": "bash scripts/build.sh playbook.yml",
"build:theme": "yarn --cwd ui build",
"serve": "yarn build && live-server build/site",
"watch:local": "fgbg 'nodemon -e yml,adoc,css,scss,js -w components -w ui --ignore ui/theme/dist -x sh scripts/watch-local-build.sh' 'live-server build/site'",
"typecheck": "tsc",
"lint": "eslint '*/**/*.{js,ts,tsx}' --quiet --fix"
"serve": "yarn build:local && live-server build/site",
"watch:local": "fgbg 'nodemon -e yml,adoc,css,scss,js -w components -w ui --ignore ui/theme/dist -x sh scripts/watch-local-build.sh' 'live-server build/site'"
},
"dependencies": {
"@antora/lunr-extension": "^1.0.0-alpha.8",
Expand Down
3 changes: 0 additions & 3 deletions playbook-master.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,3 @@ antora:
- require: './lunr-tokenizer'
- require: '@antora/lunr-extension'
index_latest_only: true
urls:
html_extension_style: drop
redirect_facility: netlify
3 changes: 0 additions & 3 deletions playbook-staging.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,3 @@ antora:
- require: './lunr-tokenizer'
- require: '@antora/lunr-extension'
index_latest_only: true
urls:
html_extension_style: drop
redirect_facility: netlify
7 changes: 0 additions & 7 deletions sidebars/governanceAppTemplateSidebar.js

This file was deleted.

7 changes: 0 additions & 7 deletions sidebars/governanceUiKitSidebar.js

This file was deleted.

7 changes: 0 additions & 7 deletions sidebars/osxSidebar.js

This file was deleted.

Empty file removed static/.nojekyll
Empty file.
Binary file removed static/img/Aragon-logo-circle.png
Binary file not shown.
Binary file removed static/img/Aragon_OSx_Thumbnail.png
Binary file not shown.
289 changes: 0 additions & 289 deletions static/img/advanced/dao/aragon-osx-dao-creation.drawio.svg

This file was deleted.

Binary file removed static/img/brand-cover.png
Binary file not shown.
Binary file removed static/img/dao/Aragon_DAO_Diagram.png
Binary file not shown.
Binary file removed static/img/dev-portal-huuman_ziy7xv.png
Binary file not shown.
515 changes: 0 additions & 515 deletions static/img/framework/aragon-os-framework-overview.drawio.svg

This file was deleted.

822 changes: 0 additions & 822 deletions static/img/framework/aragon-os-infrastructure-core-overview.drawio.svg

This file was deleted.

212 changes: 0 additions & 212 deletions static/img/framework/aragon-os-plugin-framework.drawio.svg

This file was deleted.

Binary file removed static/img/logo-dark.png
Binary file not shown.
Binary file removed static/img/logo-light.png
Binary file not shown.
Binary file removed static/img/osx_blue_logo_lqrvkr.png
Binary file not shown.
Binary file removed static/img/plugins/create_plugin_etherscan_tx.png
Binary file not shown.
312 changes: 0 additions & 312 deletions static/img/plugins/dao-plugin.drawio.svg

This file was deleted.

447 changes: 0 additions & 447 deletions static/img/plugins/plugin-installation.drawio.svg

This file was deleted.

351 changes: 0 additions & 351 deletions static/img/plugins/plugin-repo-overview.drawio.svg

This file was deleted.

468 changes: 0 additions & 468 deletions static/img/plugins/plugin-uninstallation.drawio.svg

This file was deleted.

523 changes: 0 additions & 523 deletions static/img/plugins/plugin-update.drawio.svg

This file was deleted.

155 changes: 0 additions & 155 deletions static/img/plugins/plugin-version.drawio.svg

This file was deleted.

Binary file removed static/img/plugins/what_is_a_plugin.png
Binary file not shown.
Binary file removed static/img/welcome-image.png
Binary file not shown.
Loading
Loading