Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs to use page that link to book and apis #210

Merged
merged 2 commits into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 11 additions & 44 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down Expand Up @@ -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',
Expand All @@ -129,24 +97,23 @@ module.exports = {
'/_blog/': blogSidebar,
'/blog/': blogSidebar,
'/foundation/': foundationSidebar,
'/': docsSidebar,
},
footer: {
links: [
{
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'
}
]
},
Expand Down
145 changes: 0 additions & 145 deletions docs/bdk-cli/compiler.md

This file was deleted.

20 changes: 0 additions & 20 deletions docs/bdk-cli/concept.md

This file was deleted.

99 changes: 0 additions & 99 deletions docs/bdk-cli/installation.md

This file was deleted.

Loading
Loading