Skip to content

Commit

Permalink
Prepare gh-pages (#131)
Browse files Browse the repository at this point in the history
* Adapt docs

* dummy change

* Rename workflows

* Remove all docs folder

* Ignore uploading docs

* Update references
  • Loading branch information
ausias-armesto authored Oct 3, 2024
1 parent 29e93ee commit 5a05e0c
Show file tree
Hide file tree
Showing 13 changed files with 11 additions and 4,248 deletions.
9 changes: 3 additions & 6 deletions .github/workflows/gh-pages.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
name: Merge PR
name: Docs

on:
pull_request:
types: [synchronize]
push:
branches:
- main
Expand All @@ -12,8 +10,8 @@ concurrency:
cancel-in-progress: false

jobs:
merge:
name: Merge PR
docs:
name: Generate Documentation
runs-on: self-hosted-hoprnet-small

steps:
Expand All @@ -36,5 +34,4 @@ jobs:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: docs
cname: hoprnet.org
force_orphan: true
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,5 @@ hoprnet-hopr-sdk-*.tgz

# Created by github pipeline
gha-creds-*.json

docs/
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,11 @@ console.log(res);

## Documentation

- [HoprSDK Class](https://github.com/hoprnet/hopr-sdk/blob/docs/docs/classes/HoprSDK.md)
- [API functions](https://github.com/hoprnet/hopr-sdk/blob/docs/docs/modules/api.md)
- [Flows functions](https://github.com/hoprnet/hopr-sdk/blob/docs/docs/modules/flows.md)
- [Utils](https://github.com/hoprnet/hopr-sdk/blob/docs/docs/modules/utils.md)
- [Type Aliases and Variables](https://github.com/hoprnet/hopr-sdk/blob/docs/docs/modules.md)
- [HoprSDK Class](https://hoprnet.github.io/hopr-sdk/classes/HoprSDK.html)
- [API functions](https://hoprnet.github.io/hopr-sdk/modules/api.html)
- [Flows functions](https://hoprnet.github.io/hopr-sdk/modules/flows.html)
- [Utils](https://hoprnet.github.io/hopr-sdk/modules/utils.html)
- [Type Aliases and Variables](https://hoprnet.github.io/hopr-sdk/modules.html)

## Project setup

Expand Down
1 change: 0 additions & 1 deletion docs/.nojekyll

This file was deleted.

199 changes: 0 additions & 199 deletions docs/README.md

This file was deleted.

59 changes: 0 additions & 59 deletions docs/classes/HoprSDK.md

This file was deleted.

Loading

0 comments on commit 5a05e0c

Please sign in to comment.