Skip to content

Commit

Permalink
feat: remove not needed scripts and add new info to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
clauBv23 committed Dec 17, 2024
1 parent 13c2408 commit 564cae8
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
12 changes: 9 additions & 3 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 @@ -28,7 +26,15 @@ cd ui && yarn && yarn build
### Local Build and Development

```
$ yarn build:local
$ yarn serve
```

This command starts a local development server and opens up a browser window. Changes are not reflected live, you will need to restart the server.

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.

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

### Adding a new repo to the docs

Edit the [playbook.yml](playbook.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

0 comments on commit 564cae8

Please sign in to comment.