This is an automated email from the ASF dual-hosted git repository. erickguan pushed a commit to branch ruby-binding-doc in repository https://gitbox.apache.org/repos/asf/opendal.git
commit ea52e8f996087a642a837c0054f2f153b3c81932 Author: Erick Guan <[email protected]> AuthorDate: Tue Sep 30 20:56:57 2025 +0200 Add links to rdoc and crago docs --- bindings/ruby/README.md | 13 +++++++++++++ website/docs/20-bindings/ruby.mdx | 2 +- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/bindings/ruby/README.md b/bindings/ruby/README.md index 854c3bffa..409679837 100644 --- a/bindings/ruby/README.md +++ b/bindings/ruby/README.md @@ -7,6 +7,10 @@ OpenDAL's Ruby gem.  +Read OpenDAL's [ruby](https://opendal.apache.org/docs/ruby/) documentation. + +You can find Rust documentation [here](https://docs.rs/opendal/latest/opendal/index.html). + ## Get started ### Installation @@ -111,6 +115,15 @@ op.list("/").map do |e| end ``` +## Documentation + +More detailed documentation is a work in progress. + +- OpenDAL's [ruby](https://opendal.apache.org/docs/ruby/) documentation +- Rust [documentation](https://docs.rs/opendal/latest/opendal/index.html) +- Rust documentation for [services](https://docs.rs/opendal/latest/opendal/services/index.html) +- Rust documentation for [layers](https://docs.rs/opendal/latest/opendal/layers/index.html) (middlewares in Ruby) + ## Development Install gem and its dependencies: diff --git a/website/docs/20-bindings/ruby.mdx b/website/docs/20-bindings/ruby.mdx index d75287ca5..64ccc80c0 100644 --- a/website/docs/20-bindings/ruby.mdx +++ b/website/docs/20-bindings/ruby.mdx @@ -1,5 +1,5 @@ --- -title: Ruby 🚧 +title: Ruby --- import GitHubReadme from '@site/components/GitHubReadme';
