Skip to content

Commit 3eb6a1e

Browse files
committed
Update docs to use page that link to book and apis
1 parent 83c6604 commit 3eb6a1e

File tree

2 files changed

+35
-44
lines changed

2 files changed

+35
-44
lines changed

docs/.vuepress/config.js

Lines changed: 11 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -9,42 +9,6 @@ const twitterUrl = 'https://twitter.com/intent/follow?screen_name=bitcoindevkit'
99
const nostrUrl = 'nostr:npub13dk3dke4zm9vdkucm7f6vv7vhqgkevgg3gju9kr2wzumz7nrykdq0dgnvc'
1010
const themeColor = '#ffffff'
1111

12-
const docsSidebar = [
13-
{
14-
title: 'Documentation',
15-
collapsable: false,
16-
children: [
17-
['/getting-started', 'Getting Started'],
18-
{
19-
title: "BDK-CLI",
20-
collapsable: true,
21-
children: [
22-
'/bdk-cli/introduction',
23-
'/bdk-cli/installation',
24-
'/bdk-cli/concept',
25-
'/bdk-cli/interface',
26-
'/bdk-cli/regtest',
27-
'/bdk-cli/compiler',
28-
'/bdk-cli/playground'
29-
]
30-
},
31-
'/descriptors/',
32-
'/examples/',
33-
]
34-
},
35-
{
36-
title: 'API Reference',
37-
collapsable: false,
38-
children: [
39-
['https://docs.rs/bdk_wallet/', 'Rust Stable Docs'],
40-
['https://bitcoindevkit.org/docs-rs/bdk/nightly/latest/bdk_wallet/', 'Rust Nightly Docs'],
41-
['https://bitcoindevkit.org/android/', 'Android Docs'],
42-
['https://bitcoindevkit.org/jvm/', 'Kotlin/JVM Docs'],
43-
['https://bitcoindevkit.org/java/', 'Java Docs'],
44-
],
45-
}
46-
]
47-
4812
const builtWithBdkSidebar = [
4913
{
5014
title: 'Built With BDK',
@@ -107,9 +71,13 @@ module.exports = {
10771
editLinks: true,
10872
sidebarDepth: 0,
10973
nav: [
74+
{
75+
text: 'Github',
76+
link: 'https://github.com/bitcoindevkit'
77+
},
11078
{
11179
text: 'Docs',
112-
link: '/getting-started/'
80+
link: '/docs/'
11381
},
11482
{
11583
text: 'Adoption',
@@ -129,24 +97,23 @@ module.exports = {
12997
'/_blog/': blogSidebar,
13098
'/blog/': blogSidebar,
13199
'/foundation/': foundationSidebar,
132-
'/': docsSidebar,
133100
},
134101
footer: {
135102
links: [
136103
{
137104
title: 'Docs',
138105
children: [
139106
{
140-
text: 'Getting Started',
141-
link: '/getting-started/'
107+
text: 'Book',
108+
link: '/docs/#book'
142109
},
143110
{
144-
text: 'BDK-CLI',
145-
link: '/bdk-cli/installation/'
111+
text: 'Rust APIs',
112+
link: '/docs/#rust-apis'
146113
},
147114
{
148-
text: 'Descriptors',
149-
link: '/descriptors/'
115+
text: 'Other APIs',
116+
link: '/docs/#other-apis'
150117
}
151118
]
152119
},

docs/docs/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Documentation
2+
3+
## Book
4+
5+
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.
6+
7+
- [Book of BDK](https://bitcoindevkit.github.io/book-of-bdk/)
8+
9+
## Rust APIs
10+
11+
- [bdk_wallet](https://docs.rs/bdk_wallet/)
12+
- [bdk_chain](https://docs.rs/bdk_chain/)
13+
- [bdk_sqlite](https://docs.rs/bdk_sqlite)
14+
- [bdk_electrum](https://docs.rs/bdk_electrum)
15+
- [bdk_esplora](https://docs.rs/bdk_esplora)
16+
- [bdk_bitcoind_rpc](https://docs.rs/bdk_bitcoind_rpc)
17+
- [esplora-client](https://docs.rs/esplora-client)
18+
- [electrum-client](https://docs.rs/electrum-client)
19+
20+
## Other APIs
21+
22+
- [Android Docs](https://bitcoindevkit.org/android/)
23+
- [Kotlin/JVM Docs](https://bitcoindevkit.org/jvm/)
24+
- [Java Docs](https://bitcoindevkit.org/java/)

0 commit comments

Comments
 (0)