Skip to content

Commit

Permalink
Merge pull request #204 from oasisprotocol/CedarMist/docs-links
Browse files Browse the repository at this point in the history
README: added api-docs links
  • Loading branch information
CedarMist authored Oct 19, 2023
2 parents c4b8e09 + d7636ac commit 259e05e
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@ This monorepo includes the source code for the following Sapphire packages:
## Documentation

The Sapphire Paratime documentation is deployed as part of the full set of Oasis [docs](https://docs.oasis.io/dapp/sapphire/)
based on this open source [repository](https://github.com/oasisprotocol/docs).
based on this open source [repository](https://github.com/oasisprotocol/docs). Auto-generated API documentation is available at:

* https://api.docs.oasis.io/js/sapphire-paratime/
* https://api.docs.oasis.io/sol/sapphire-contracts/

## Layout

Expand All @@ -28,7 +31,7 @@ the following directories:

- [`clients`](./clients): the Go and TypeScript clients
- [`contracts`](./contracts): Sapphire and [OPL](https://docs.oasis.io/dapp/opl/) smart contracts
- [`examples`](./examples/): sample code snippets in popular Ethereum
- [`examples`](./examples/): sample code snippets in popular Ethereum
development environments
- [`integrations`](./integrations/): plugins with popular Solidity tools
- [`runtime`](./runtime/): the Sapphire Paratime as based off of the
Expand Down

0 comments on commit 259e05e

Please sign in to comment.