From 5dd79e96325d23b76a95584c863743032edec538 Mon Sep 17 00:00:00 2001 From: thunderbiscuit Date: Wed, 14 Dec 2022 15:00:43 -0500 Subject: [PATCH] Add readme to api-docs directory --- api-docs/README.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 api-docs/README.md diff --git a/api-docs/README.md b/api-docs/README.md new file mode 100644 index 0000000..09ac647 --- /dev/null +++ b/api-docs/README.md @@ -0,0 +1,6 @@ +# API documentation +The Bitcoin Dev Kit language bindings make use of the [uniffi-rs](https://github.com/mozilla/uniffi-rs) library to produce their bindings. While efforts are ongoing to allow inline documentation on the Rust side to be ported to the bindings code, this is not currently possible. + +This directory contains our temporary solution to this problem. A set of files mimicking the bindings libraries in their function signatures, but without any implementation. This allows for documentation build tools to produce API docs similarly to how we would like them to be if they could be inlined. + +You can find the resulting API documentation websites in the ["API Reference" section of the sidebar](https://bitcoindevkit.org/getting-started/) under the "Docs" tab on the bitcoindevkit official website.