We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 0c78abf commit c799b2cCopy full SHA for c799b2c
1 file changed
README.md
@@ -0,0 +1,16 @@
1
+# Oasis API reference documentation
2
+
3
+Branch `gh-pages` in this repository hosts the https://api.docs.oasis.io
4
+site.
5
6
+## `gh-pages` organization
7
8
+- `js`: holds JavaScript and TypeScript packages named after the package name
9
+ deployed at npmjs.org, but with stripped `@oasisprotocol/` prefix. For example
10
+ `@oasisprotocol/client` is hosted inside `js/client` path.
11
+- `rust`: holds Rust packages named after the import name of the package e.g.
12
+ `oasis_runtime_sdk`.
13
14
+The branch is periodically updated by fetching the content of `api-reference`
15
+branch of the `oasis-sdk`, `sapphire-paratime` and other relevant Oasis
16
+repositories.
0 commit comments