diff options
| author | hozan23 <hozan23@proton.me> | 2023-11-22 23:25:20 +0300 |
|---|---|---|
| committer | hozan23 <hozan23@proton.me> | 2023-11-22 23:25:20 +0300 |
| commit | eaa0c2bd4d59c8c90027604d718de96ca4b34f9e (patch) | |
| tree | adc9a1d2ad9702d38aea85b01416422f95c6415e | |
| parent | 8981f3d12bb8dd699254371da356d5a441f0a630 (diff) | |
README: add online docs in docs section
| -rw-r--r-- | .github/workflows/docs.yml | 3 | ||||
| -rw-r--r-- | README.md | 12 |
2 files changed, 9 insertions, 6 deletions
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 6711231..318375a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -3,11 +3,10 @@ name: Build and Deploy Rust API Docs on: push: branches: - - test-ci-docs + - main jobs: docs: - name: build karyons rust api docs runs-on: ubuntu-latest permissions: contents: write @@ -31,11 +31,15 @@ including TLS implementation. You can check the ## Docs -To generate karyons Rust API Documentation, run the following command: +Online documentation for the main crates: -```bash -$ cargo doc --no-deps --all --document-private-items --open -``` +- [karyons_p2p](https://karyons.github.io/karyons/karyons_p2p) +- [karyons_jsonrpc](https://karyons.github.io/karyons/karyons_jsonrpc) + +For the internal crates: + +- [karyons_core](https://karyons.github.io/karyons/karyons_core) +- [karyons_net](https://karyons.github.io/karyons/karyons_net) ## Thanks |