From 3eb6a1e70d310b485df8f93f8e26e5c96fc8d99d Mon Sep 17 00:00:00 2001 From: Steve Myers Date: Thu, 30 Jan 2025 14:57:30 -0600 Subject: [PATCH] Update docs to use page that link to book and apis --- docs/.vuepress/config.js | 55 ++++++++-------------------------------- docs/docs/README.md | 24 ++++++++++++++++++ 2 files changed, 35 insertions(+), 44 deletions(-) create mode 100644 docs/docs/README.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index b4583e8d19..a1f58ac1b8 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -9,42 +9,6 @@ const twitterUrl = 'https://twitter.com/intent/follow?screen_name=bitcoindevkit' const nostrUrl = 'nostr:npub13dk3dke4zm9vdkucm7f6vv7vhqgkevgg3gju9kr2wzumz7nrykdq0dgnvc' const themeColor = '#ffffff' -const docsSidebar = [ - { - title: 'Documentation', - collapsable: false, - children: [ - ['/getting-started', 'Getting Started'], - { - title: "BDK-CLI", - collapsable: true, - children: [ - '/bdk-cli/introduction', - '/bdk-cli/installation', - '/bdk-cli/concept', - '/bdk-cli/interface', - '/bdk-cli/regtest', - '/bdk-cli/compiler', - '/bdk-cli/playground' - ] - }, - '/descriptors/', - '/examples/', - ] - }, - { - title: 'API Reference', - collapsable: false, - children: [ - ['https://docs.rs/bdk_wallet/', 'Rust Stable Docs'], - ['https://bitcoindevkit.org/docs-rs/bdk/nightly/latest/bdk_wallet/', 'Rust Nightly Docs'], - ['https://bitcoindevkit.org/android/', 'Android Docs'], - ['https://bitcoindevkit.org/jvm/', 'Kotlin/JVM Docs'], - ['https://bitcoindevkit.org/java/', 'Java Docs'], - ], - } -] - const builtWithBdkSidebar = [ { title: 'Built With BDK', @@ -107,9 +71,13 @@ module.exports = { editLinks: true, sidebarDepth: 0, nav: [ + { + text: 'Github', + link: 'https://github.com/bitcoindevkit' + }, { text: 'Docs', - link: '/getting-started/' + link: '/docs/' }, { text: 'Adoption', @@ -129,7 +97,6 @@ module.exports = { '/_blog/': blogSidebar, '/blog/': blogSidebar, '/foundation/': foundationSidebar, - '/': docsSidebar, }, footer: { links: [ @@ -137,16 +104,16 @@ module.exports = { title: 'Docs', children: [ { - text: 'Getting Started', - link: '/getting-started/' + text: 'Book', + link: '/docs/#book' }, { - text: 'BDK-CLI', - link: '/bdk-cli/installation/' + text: 'Rust APIs', + link: '/docs/#rust-apis' }, { - text: 'Descriptors', - link: '/descriptors/' + text: 'Other APIs', + link: '/docs/#other-apis' } ] }, diff --git a/docs/docs/README.md b/docs/docs/README.md new file mode 100644 index 0000000000..ed20132c76 --- /dev/null +++ b/docs/docs/README.md @@ -0,0 +1,24 @@ +# Documentation + +## Book + +The "Book of BDK" is a gentle introduction to using the BDK suite of libraries. It includes a "Getting Started" guide and "Cookbook" with example code in Rust, Kotlin and Swift. It is still a work in progress, contributions welcome. + +- [Book of BDK](https://bitcoindevkit.github.io/book-of-bdk/) + +## Rust APIs + +- [bdk_wallet](https://docs.rs/bdk_wallet/) +- [bdk_chain](https://docs.rs/bdk_chain/) +- [bdk_sqlite](https://docs.rs/bdk_sqlite) +- [bdk_electrum](https://docs.rs/bdk_electrum) +- [bdk_esplora](https://docs.rs/bdk_esplora) +- [bdk_bitcoind_rpc](https://docs.rs/bdk_bitcoind_rpc) +- [esplora-client](https://docs.rs/esplora-client) +- [electrum-client](https://docs.rs/electrum-client) + +## Other APIs + +- [Android Docs](https://bitcoindevkit.org/android/) +- [Kotlin/JVM Docs](https://bitcoindevkit.org/jvm/) +- [Java Docs](https://bitcoindevkit.org/java/) \ No newline at end of file -- 2.49.0