Skip to content

Commit

Permalink
README: Add sol description
Browse files Browse the repository at this point in the history
  • Loading branch information
matevz committed Sep 25, 2023
1 parent c799b2c commit 2b82079
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,17 @@ site.

## `gh-pages` organization

- `js`: holds JavaScript and TypeScript packages named after the package name
deployed at npmjs.org, but with stripped `@oasisprotocol/` prefix. For example
`@oasisprotocol/client` is hosted inside `js/client` path.
- `rust`: holds Rust packages named after the import name of the package e.g.
`oasis_runtime_sdk`.
- `js`: contains API reference for JavaScript and TypeScript packages named
after the package name deployed at npmjs.org, but with stripped
`@oasisprotocol/` prefix. For example `@oasisprotocol/client` is hosted
inside `js/client` folder.
- `sol`: contains API reference for Solidity packages named after the package
name deployed at npmjs.org, but with stripped `@oasisprotocol/` prefix. For
example `@oasisprotocol/sapphire-contracts` is hosted inside
`sol/sapphire-contracts`.
- `rust`: contains API reference for Rust packages named after the import name
of the package e.g. `oasis_runtime_sdk`.

The branch is periodically updated by fetching the content of `api-reference`
branch of the `oasis-sdk`, `sapphire-paratime` and other relevant Oasis
repositories.
`gh-pages` branch is periodically updated by fetching the content of
`api-reference` branch of the `oasis-sdk`, `sapphire-paratime` and other Oasis
repositories in the future.

0 comments on commit 2b82079

Please sign in to comment.