mirrors/bitcoin-s
1
0
Fork 0
mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2025-03-04 02:54:00 +01:00
Code Issues Projects Releases Packages Wiki Activity
bitcoin-s/website/sidebars.json

40 lines
895 B
JSON
Raw Normal View History

WIP: Docusaurus website (#465) * Docs: Introduce new Docusaurus-based website This commit is the result of running npx docusaurus-init, and nothing more. Further changes will happen on top of this, to make it easier to review changes and update to newer versions of Docusaurus in the future. * WIP: Add Bitcoin-S website Change the default Docusaurus template to a custom website. Goes off of existing documentation, and moves it into the new docs and website directories. Deletes some unused files, such as BUILD_README.md * Initial mdoc support * Add Scaladoc to website * Add SVG assets * Change colors, flesh out pages, correct Scaladoc links * Rename doc project to scripts, move security doc to website * Add copy buttons to website code snippets * Add doc and tasks for publishing website * Refactor how paths get copied after generating Scaladocs * Add Get Started button * Replace bitcoin-s logo with white text * Add Montserrat font for headers * flesh out user showcase and landing page * Change Scaladoc URL to bitcoins package
2019-05-15 01:05:14 +02:00
{
"docs": {
"Getting started": ["getting-started"],
Added a getting-setup markdown doc for the website (#1167) * Added a getting-setup markdown doc for the website * Responded to Ben's review * Added testnet section * Added DLC doc * Got the website working locally * Fixed linking * Responded to review
2020-02-26 13:09:44 -07:00
"Getting setup": ["getting-setup"],
Add sections on generating addresses and expand HD section in website
2019-06-11 14:55:59 +02:00
"Core module": [
"core/core-intro",
"core/addresses",
"core/hd-keys",
Adding new SPK doc (#1208) * Added a document explaining how to add new script types. * built website * Added a doc explaining the differences between full and single signing * Added design philosophy section * Responded to review * mdoc now compiles the code within adding-spks.md, with some caveats surrounding sealed traits * Added explanitory comment
2020-03-10 13:30:16 -06:00
"core/adding-spks",
"core/spending-info",
2019 12 17 sign ext key (#959) * Create ExtSign, use it on ExtPrivateKey * Add documentation on how to Sign things with ExtSign * Add ExtSign.sign for a bip32 path * Make sign(bytes,path) not return a Future, add documentation * Address nadav's code review * Fix mdoc sign.md
2019-12-20 12:47:10 -06:00
"core/sign",
Add PSBTs to Docs Sidebar (#1172)
2020-02-26 16:06:57 -06:00
"core/psbts",
Add sections on generating addresses and expand HD section in website
2019-06-11 14:55:59 +02:00
"core/txbuilder"
],
Move initialization of wallet entropy into the key manager (#966) * Move initialization of wallet entropy into the key manager * Enable key-manager in ci, add coverage minimum * Add coverage minimum for key manager, add KeyManagerParams, start adding KeyManager test harness * Remove success cases on ADTs, start using Either * fix import * Get test coverage to 90% * Add documentation for key-manager.md, add side bar for key-manager * Fix wallet.md * Make seedPath default to baseDatadir, so we don't have a unique seed for every network. Add more documentation * Address code review * Address code review from Ben * Add missing import * Add more tests for coverage
2019-12-26 19:12:08 -06:00
"Key manager": [
"key-manager/key-manager"
],
ChainQueryApi doc (#1204) * ChainQueryApi doc * Add example * make imports invis, add example * Fix invis imports
2020-03-11 08:56:37 -05:00
"Wallet": [
"wallet/chain-query-api"
],
WIP: Docusaurus website (#465) * Docs: Introduce new Docusaurus-based website This commit is the result of running npx docusaurus-init, and nothing more. Further changes will happen on top of this, to make it easier to review changes and update to newer versions of Docusaurus in the future. * WIP: Add Bitcoin-S website Change the default Docusaurus template to a custom website. Goes off of existing documentation, and moves it into the new docs and website directories. Deletes some unused files, such as BUILD_README.md * Initial mdoc support * Add Scaladoc to website * Add SVG assets * Change colors, flesh out pages, correct Scaladoc links * Rename doc project to scripts, move security doc to website * Add copy buttons to website code snippets * Add doc and tasks for publishing website * Refactor how paths get copied after generating Scaladocs * Add Get Started button * Replace bitcoin-s logo with white text * Add Montserrat font for headers * flesh out user showcase and landing page * Change Scaladoc URL to bitcoins package
2019-05-15 01:05:14 +02:00
"RPC clients": [
"rpc/rpc-clients-intro",
"rpc/rpc-eclair",
"rpc/rpc-bitcoind"
],
Add rudimentary docs for node, chain and wallet (#726)
2019-09-02 15:16:44 +02:00
"Applications": [
"applications/chain",
2020 03 08 filter sync (#1209) * Create FilterSync, which gives us an API inside of the chain project to sync filters with Add another unit test to filter sync Add more unit tests for ChainSync and FilterSync Clean up some docs, remove some extra lines of code Run scalafmt Add filter-sync.md Cleanup some nits Add more information of how FilterSync.syncFilters() works Add 'FilterWithHeaderHash' type so that we can actually validate/verify block headers that are being fed into the chain project Run scalafmt, hide imports in filter-sync.md so code appears cleaner Move implicits out of invisible block as it seems to cause errors Make it so FilterSync processes filters in batches rather than fetching them all at once Fix compile error * Add comment about trust model * Run scalafmt
2020-03-10 18:01:14 -05:00
"applications/filter-sync",
Add version 0.2.0 of the website (#948)
2019-12-16 05:57:14 -06:00
"applications/cli",
"applications/configuration",
Added a getting-setup markdown doc for the website (#1167) * Added a getting-setup markdown doc for the website * Responded to Ben's review * Added testnet section * Added DLC doc * Got the website working locally * Fixed linking * Responded to review
2020-02-26 13:09:44 -07:00
"applications/dlc",
Add version 0.2.0 of the website (#948)
2019-12-16 05:57:14 -06:00
"applications/node",
"applications/server",
"applications/wallet"
Add rudimentary docs for node, chain and wallet (#726)
2019-09-02 15:16:44 +02:00
],
WIP: Docusaurus website (#465) * Docs: Introduce new Docusaurus-based website This commit is the result of running npx docusaurus-init, and nothing more. Further changes will happen on top of this, to make it easier to review changes and update to newer versions of Docusaurus in the future. * WIP: Add Bitcoin-S website Change the default Docusaurus template to a custom website. Goes off of existing documentation, and moves it into the new docs and website directories. Deletes some unused files, such as BUILD_README.md * Initial mdoc support * Add Scaladoc to website * Add SVG assets * Change colors, flesh out pages, correct Scaladoc links * Rename doc project to scripts, move security doc to website * Add copy buttons to website code snippets * Add doc and tasks for publishing website * Refactor how paths get copied after generating Scaladocs * Add Get Started button * Replace bitcoin-s logo with white text * Add Montserrat font for headers * flesh out user showcase and landing page * Change Scaladoc URL to bitcoins package
2019-05-15 01:05:14 +02:00
"Contributing": ["contributing", "contributing-website"],
"Security": ["security"]
}
}
Reference in a new issue Copy permalink